openapi: 3.0.0 info: title: Asana description: "This is the interface for interacting with the [Asana Platform](https://developers.asana.com).\ \ Our API reference is generated from our [OpenAPI spec] (https://raw.githubusercontent.com/Asana/openapi/master/defs/asana_oas.yaml)." termsOfService: https://asana.com/terms contact: name: Asana Support url: https://asana.com/support license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 version: "1.0" x-public-description: "This is the interface for interacting with the [Asana Platform](https://developers.asana.com).\ \ Our API reference is generated from our [OpenAPI spec] (https://raw.githubusercontent.com/Asana/openapi/master/defs/asana_oas.yaml)." x-docs-schema-whitelist: - AsanaResource - AsanaNamedResource - AuditLogEvent - AttachmentResponse - AttachmentCompact - BatchResponse - CustomFieldSettingResponse - CustomFieldSettingCompact - CustomFieldResponse - CustomFieldCompact - EnumOption - EventResponse - ErrorResponse - GoalResponse - GoalCompact - GoalMembershipCompact - GoalMembershipBase - GoalMembershipResponse - GoalRelationshipResponse - GoalRelationshipCompact - JobResponse - JobCompact - OrganizationExportResponse - OrganizationExportCompact - PortfolioMembershipResponse - PortfolioMembershipCompact - PortfolioResponse - PortfolioCompact - ProjectBriefResponse - ProjectBriefCompact - ProjectMembershipCompactResponse - ProjectMembershipNormalResponse - ProjectMembershipCompact - ProjectResponse - ProjectCompact - ProjectStatusResponse - ProjectStatusCompact - ProjectTemplateCompact - ProjectTemplateResponse - RuleTriggerResponse - SectionResponse - SectionCompact - StatusUpdateResponse - StatusUpdateCompact - StoryResponse - StoryCompact - TagResponse - TagCompact - TaskResponse - TaskCompact - TaskCountResponse - TeamMembershipResponse - TeamMembershipCompact - TeamResponse - TeamCompact - TimePeriodResponse - TimePeriodCompact - UserTaskListResponse - UserTaskListCompact - UserResponse - UserCompact - WebhookFilter - WebhookResponse - WebhookCompact - WorkspaceMembershipResponse - WorkspaceMembershipCompact - WorkspaceResponse - WorkspaceCompact servers: - url: https://app.asana.com/api/1.0 description: Main endpoint. security: - personalAccessToken: [] - oauth2: [] tags: - name: Allocations description: "An allocation object represents how much of a resource (e.g. person,\ \ team) is dedicated to a specific work object (e.g. project, portfolio) over\ \ a specific period of time. The effort value of an allocation object can be a\ \ percentage or number of hours." - name: Attachments description: "An *attachment* object represents any file attached to a task in Asana,\ \ whether it’s an uploaded file or one associated via a third-party service such\ \ as Dropbox or Google Drive." - name: Audit log API description: |- Asana's audit log is an immutable log of [important events](/docs/audit-log-events#supported-audit-log-events) in your organization's Asana instance. The audit log API allows you to monitor and act upon important security and compliance-related changes. Organizations might use this API endpoint to: * Set up proactive alerting with a Security Information and Event Management (SIEM) tool like [Splunk](https://asana.com/guide/help/api/splunk) * Conduct reactive investigations when a security incident takes place * Visualize key domain data in aggregate to identify security trends Note that since the API provides insight into what is happening in an Asana instance, the data is [read-only](/reference/getauditlogevents). That is, there are no "write" or "update" endpoints for audit log events. Only [Service Accounts](https://asana.com/guide/help/premium/service-accounts) in [Enterprise Domains](https://asana.com/enterprise) can access audit log API endpoints. Authentication with a Service Account's [personal access token](/docs/personal-access-token) is required. For a full list of supported events, see [supported AuditLogEvents](/docs/audit-log-events#supported-audit-log-events). - name: Batch API description: |- There are many cases where you want to accomplish a variety of work in the Asana API but want to minimize the number of HTTP requests you make. For example: * Modern browsers limit the number of requests that a single web page can make at once. * Mobile apps will use more battery life to keep the cellular radio on when making a series of requests. * There is an overhead cost to developing software that can make multiple requests in parallel. * Some cloud platforms handle parallelism poorly, or disallow it entirely. To make development easier in these use cases, Asana provides a **batch API** that enables developers to perform multiple “actions” by making only a single HTTP request. #### Making a batch request To make a batch request, send a `POST` request to `/batch`. Like other `POST` endpoints, the body should contain a `data` envelope. Inside this envelope should be a single `actions` field, containing a list of “action” objects. Each action represents a standard request to an existing endpoint in the Asana API. **The maximum number of actions allowed in a single batch request is 10**. Making a batch request with no actions in it will result in a `400 Bad Request`. When the batch API receives the list of actions to execute, it will dispatch those actions to the already-implemented endpoints specified by the `relative_path` and `method` for each action. This happens in parallel, so all actions in the request will be processed simultaneously. There is no guarantee of the execution order for these actions, nor is there a way to use the output of one action as the input of another action (such as creating a task and then commenting on it). The response to the batch request will contain (within the `data` envelope) a list of result objects, one for each action. The results are guaranteed to be in the same order as the actions in the request (e.g., the first result in the response corresponds to the first action in the request) The batch API will always attempt to return a `200 Success` response with individual result objects for each individual action in the request. Only in certain cases (such as missing authorization or malformed JSON in the body) will the entire request fail with another status code. Even if every individual action in the request fails, the batch API will still return a `200 Success` response, and each result object in the response will contain the errors encountered with each action. #### Rate limiting The batch API fully respects all of our rate limiting. This means that a batch request counts against *both* the standard rate limiter and the concurrent request limiter as though you had made a separate HTTP request for every individual action. For example, a batch request with five actions counts as five separate requests in the standard rate limiter, and counts as five concurrent requests in the concurrent request limiter. The batch request itself incurs no cost. If any of the actions in a batch request would exceed any of the enforced limits, the *entire* request will fail with a `429 Too Many Requests` error. This is to prevent the unpredictability of which actions might succeed if not all of them could succeed. #### Restrictions Not every endpoint can be accessed through the batch API. Specifically, the following actions cannot be taken and will result in a `400 Bad Request` for that action: * Uploading attachments * Creating, getting, or deleting organization exports * Any SCIM operations * Nested calls to the batch API - name: Custom fields description: |- _Note: Custom fields are a premium feature. Integrations which work with custom fields need to handle an assortment of use cases for free and premium users in context of free and premium organizations. For a detailed examination of which data users will have access in different circumstances, review the section below on access control._ In the Asana application, tasks, projects, and portfolios can hold user-specified [custom fields](https://asana.com/guide/help/premium/custom-fields) which provide extra information (e.g., a "priority" property with an associated value, or a number representing the time required to complete a task). This lets a user define the type of information that each item within a project or portfolio can contain in addition to the built-in fields that Asana provides. `display_value` is a read-only field that will always be a string. For apps that use custom fields, this is a great way to safely display/export the value of a custom field, regardless of its type. We suggest apps use this field in order to future-proof for changes to custom fields. #### Characteristics of custom fields * There is metadata that defines the custom field. This metadata can be shared across an entire workspace, or be specific to a project or portfolio. * Creating a custom field setting on a project or portfolio means each direct child will have the custom field. This is conceptually akin to adding columns in a database or a spreadsheet: every task (row) in the project (table) can contain information for that field, including "blank" values (i.e., `null` data). For portfolio custom fields, every project (row) in the portfolio (table) will contain information for the custom field. * Custom field settings only go one child deep. This means that a custom field setting on a portfolio will give each project the custom field, but not each task within those projects. * Tasks have custom field _values_ assigned to them. #### Types of custom fields Integrations using custom fields need to be aware of the six basic types that a custom field can adopt. These types are: * `text` - an arbitrary, relatively short string of text * `number` - a number with a defined level of precision * `enum` - a selection of a single option from a defined list of options (i.e., mutually exclusive selections) * `multi_enum` - a selection of one or more options from a defined list of options (i.e., mutually inclusive selections) * `date` - a reference date with an optional time value * `people` - a list of active contributors (i.e., where their relationship to the work is defined in the custom field title) #### Example use case Consider an organization that has defined a custom field for "Priority". This field is of `enum` type and can have user-defined values of `Low`, `Medium`, or `High`. This is the field metadata, and it is visible within, and shared across, the entire organization. A project is then created in the organization, called "Bugs", and the "Priority" custom field is associated with that project. This will allow all tasks within the "Bugs" project to have an associated "Priority". A new task is created within "Bugs". This task, then, has a field named "Priority" which can take on the custom field value of one of `[null]`, `Low`, `Medium`, and `High`. #### Custom fields in the API These custom fields are accessible via the API through a number of endpoints at the top level (e.g. `/custom_fields` and `/custom_field_settings`) and through requests on workspaces, portfolios, projects, and tasks resources. The API also provides a way to fetch both the metadata and data which define each particular custom field, so that a client application may render proper UI to display or edit the values. Text fields are currently limited to 1024 characters. On tasks, their custom field value will have a `text_value` property to represent this field. Number fields can have an arbitrary `precision` associated with them; for example, a precision of `2` would round its value to the second (hundredths) place (e.g., `1.2345` would round to `1.23`). On tasks, the custom field value will have a `number_value` property to represent this field. #### Enum fields Enum fields represent a selection from a list of options. On the metadata, they will contain all of the options in an array. Each option has 4 properties: * `gid` - the GID of this enum option. Note that this is the GID of the individual _option_. The custom field itself has a separate `gid`. * `name` - the name of the option (e.g., "Choice #1") * `enabled` - whether this field is enabled. Disabled fields are not available to choose from when disabled, and are visually hidden in the Asana application, but they remain in the metadata for custom field values which were set to the option before the option was disabled. * `color` - a color associated with this choice. On the task's custom field value, the enum will have an `enum_value` property which will be the same as one of the choices from the list defined in the custom field metadata. #### Querying an organization for its custom fields For custom fields shared across the workspace or organization, the workspace [can be queried](/reference/getcustomfieldsforworkspace) for its list of defined custom fields. Like other collection queries, the fields will be returned as a compact record; slightly different from most other compact records is the fact that the compact record for custom fields includes `type` as well as `gid` and `name`. #### Accessing custom field definitions The [custom fields](/reference/getcustomfield) reference describes how the metadata which defines a custom field is accessed. A GET request with a `gid` can be issued on the `/custom_fields` endpoint to fetch the full definition of a single custom field given its `gid` from (for instance) listing all custom fields on a workspace, or getting the `gid` from a custom field settings object or a task. #### Associating custom fields with a project or portfolio A mapping between a custom field and a project or portfolio is handled with a [custom field settings](/reference/custom-field-settings) object. This object contains a reference for each of the custom fields and the project or portfolio, as well as additional information about the status of that particular custom field (e.g., `is_important`, which defines whether or not the custom field will appear in the list/grid on the Asana application). #### Accessing custom field values on tasks or projects The [tasks](/reference/gettask) reference has information on how custom fields look on tasks. custom fields will return as an array on the property `custom_fields`, and each entry will contain, side-by-side, the compact representation of the custom field metadata and a `{typename}_value` property that stores the value set for the custom field. Of particular note is that the top-level `gid` of each entry in the `custom_fields` array is the `gid` of the custom field metadata, as it is the compact representation of this metadata. This can be used to refer to the full metadata by making a request to the `/custom_fields/{custom_fields_id}` endpoint as described above. Custom fields can be set just as in the Asana-defined fields on a task via `POST` or `PUT` requests. You can see an example in the [update a task](/reference/updatetask) endpoint. Custom fields on projects follow this same pattern. #### Warning: Program defensively with regards to custom field definitions Asana application users have the ability to change the definitions of custom field metadata. This means that as you write scripts or applications to work with them, it is possible for the definitions to change at any time, which may cause an application using them to break or malfunction if it makes assumptions about the metadata for a particular custom field. When using custom fields, it is a good idea to program *defensively*, meaning you your application should double-check that the custom field metadata are what it expects. Storing the state of the custom field metadata for too long if you dynamically create a model for it can cause your model to become out of sync with the model stored in Asana. For example, if you encounter an `enum` value on a task that does not match any option in your metadata model, your metadata model has become out of date with the custom field metadata. #### Enabled and disabled values When information that is contained in a custom field value loses a logical association with its metadata definition, the value becomes disabled. This can happen in a couple of simple ways, for example, if you remove the custom field metadata from a project, or move a task with a custom field to a different project which does not have the custom field metadata associated with it. The value remains on the task, and the custom field metadata can still be found and examined, but as the context in which the custom field makes sense is gone, the custom field cannot change its value; it can only be cleared. _Note: Tasks that are associated with multiple projects do not become disabled, so long as at least one of the projects is still associated with the custom field metadata. In other words, tasks with multiple projects will retain logically associated to the set of custom field metadata represented by all of their projects._ Moving the task back under a project with that custom field applied to it or applying the custom field metadata to the current project will return the custom field value to an enabled state. In this scenario, the custom field will be re-enabled and editable again. In the Asana application, disabled fields are grayed out and not allowed to change, other than to be discarded. In the API, we return a property `enabled: false` to inform the external application that the value has been disabled. Note that the API enforces the same operations on disabled custom field values as hold in the Asana application: they may not have their values changed, since the lack of context for the values of a custom field in general doesn't provide enough information to know what new values should be. Setting the custom field value to `null` will clear and remove the custom field value from the task. #### Custom field access control Custom fields are a complex feature of the Asana platform, and their access in the Asana application and in the API vary based on the status of the user and project. When building your application, it is best to be defensive and not assume the given user will have read or write access to a custom field, and fail gracefully when this occurs. - name: Custom field settings description: "Custom fields are attached to a particular project with the custom\ \ field settings resource. This resource both represents the many-to-many join\ \ of the custom field and project as well as stores information that is relevant\ \ to that particular pairing. For instance, the `is_important` property determines\ \ some possible application-specific handling of that custom field." - name: Events description: |- An event is an object representing a change to a resource that was observed by an event subscription. Event streams rely on the same infrastructure as webhooks, which ensures events are delivered within a minute (on average). This system is designed for at most once delivery, meaning in exceptional circumstances a small number of events may be missing from the stream. For this reason, if your use case requires strong guarantees about processing all changes on a resource and cannot tolerate any missing events, regardless of how rare that might be, we recommend building a fallback polling system that fetches the resource periodically as well. Note that while webhooks cannot be replayed once delivered, events are retrievable from the event stream for 24 hours after being processed. In general, requesting events on a resource is faster and subject to higher rate limits than requesting the resource itself. Additionally, change events "bubble up" (e.g., listening to events on a project would include when stories are added to tasks in the project, and even to subtasks). Establish an initial sync token by making a request with no sync token. The response will be a `412 Precondition Failed` error - the same as if the sync token had expired. Subsequent requests should always provide the sync token from the immediately preceding call. Sync tokens may not be valid if you attempt to go "backward" in the history by requesting previous tokens, though re-requesting the current sync token is generally safe, and will always return the same results. When you receive a `412 Precondition Failed` error, it means that the sync token is either invalid or expired. If you are attempting to keep a set of data in sync, this signals you may need to re-crawl the data. Sync tokens always expire after 24 hours, but may expire sooner, depending on load on the service. - name: Goals description: A goal is an object in the goal-tracking system that helps your organization drive measurable results. - name: Goal relationships description: "A goal relationship is an object representing the relationship between\ \ a goal and another goal, a project, a task, or a portfolio." - name: Jobs description: |- Jobs represent processes that handle asynchronous work. A job created when an endpoint requests an action that will be handled asynchronously, such as project or task duplication. Only the creator of the duplication process can access the duplication status of the new object. *Note*: With any work that is handled asynchronously (e.g., [project instantation from a template](/reference/instantiateproject), duplicating a [task](/reference/duplicatetask) or [project](/reference/duplicateproject), etc.), the *intermittent states* of newly-created objects may not be consistent. That is, object properties may return different values each time when polled until the job `status` has returned a `succeeded` value. - name: Organization exports description: |- An `organization_export` object represents a request to export the complete data of an organization in JSON format. To export an organization using this API: * Create an `organization_export` [request](/reference/createorganizationexport) and store the ID that is returned. * Request the `organization_export` every few minutes, until the `state` field contains ‘finished’. * Download the file located at the URL in the `download_url` field. * Exports can take a long time, from several minutes to a few hours for large organizations. *Note: These endpoints are only available to [Service Accounts](https://asana.com/guide/help/premium/service-accounts) of an [Enterprise](https://asana.com/enterprise) organization.* - name: Portfolios description: |- A portfolio gives a high-level overview of the status of multiple initiatives in Asana. Portfolios provide a dashboard overview of the state of multiple projects, including a progress report and the most recent [status update](/reference/status-updates). Portfolios have some restrictions on size. Each portfolio has a max of 500 items and, like projects, a maximum of 20 custom fields. - name: Portfolio memberships description: This object determines if a user is a member of a portfolio. - name: Projects description: |- A project represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. A project exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions. Projects in organizations are shared with a single team. Currently, the team of a project cannot be changed via the API. Non-organization workspaces do not have teams and so you should not specify the team of project in a regular workspace. Followers of a project are a subset of the members of that project. Followers of a project will receive all updates including tasks created, added and removed from that project. Members of the project have access to and will receive status updates of the project. Adding followers to a project will add them as members if they are not already, removing followers from a project will not affect membership. **Note:** You can use certain project endpoints to operate on [user task lists](/reference/user-task-lists) ([My Tasks](https://asana.com/guide/help/fundamentals/my-tasks)) by substituting the `{project_gid}` with the `{user_task_list_gid}`. For example, you can perform operations on the custom fields of a user task list by using the following projects endpoints: [Add a custom field to a project](/reference/addcustomfieldsettingforproject), [Remove a custom field from a project](/reference/removecustomfieldsettingforproject) and [Get a project's custom fields](/reference/getcustomfieldsettingsforproject) - name: Project briefs description: |- A project brief object represents a rich text document that describes a project. Please note that this API is in *preview*, and is expected to change. This API is to be used for development and testing only as an advance view into the upcoming rich text format experience in the task description. For more information, see [this post](https://forum.asana.com/t/project-brief-api-now-available-as-a-preview/150885) in the developer forum. - name: Project memberships description: "With the introduction of “comment-only” projects in Asana, a user’\ s membership in a project comes with associated permissions. These permissions\ \ (i.e., whether a user has full access to the project or comment-only access)\ \ are accessible through the project memberships endpoints described here." - name: Project statuses description: |- *Deprecated: new integrations should prefer using [status updates](/reference/status-updates)* A project status is an update on the progress of a particular project, and is sent out to all project followers when created. These updates include both text describing the update and a color code intended to represent the overall state of the project: "green" for projects that are on track, "yellow" for projects at risk, "red" for projects that are behind, and "blue" for projects on hold. Project statuses can be created and deleted, but not modified. - name: Project templates description: |- A project template is an object that allows new projects to be created with a predefined setup, which may include tasks, sections, rules, etc. It simplifies the process of running a workflow that involves a similar set of work every time. Project templates in organizations are shared with a single team. Currently, the team of a project template cannot be changed via the API. - name: Sections description: |- A section is a subdivision of a project that groups tasks together. It can either be a header above a list of tasks in a list view or a column in a board view of a project. Sections are largely a shared idiom in Asana’s API for both list and board views of a project regardless of the project’s layout. The ‘memberships’ property when [getting a task](/reference/gettask) will return the information for the section or the column under ‘section’ in the response. - name: Status updates description: |- A status update is an update on the progress of a particular object, and is sent out to all followers when created. These updates include both text describing the update and a `status_type` intended to represent the overall state of the project. These include: `on_track` for projects that are on track, `at_risk` for projects at risk, `off_track` for projects that are behind, and `on_hold` for projects on hold. Status updates can be created and deleted, but not modified. - name: Stories description: |- *See [our forum post](https://forum.asana.com/t/no-more-parsing-story-text-new-fields-on-stories/42924) for more info on when conditional fields are returned.* A story represents an activity associated with an object in the Asana system. Stories are generated by the system whenever users take actions such as creating or assigning tasks, or moving tasks between projects. "Comments" are also a form of user-generated story. - name: Tags description: |- A tag is a label that can be attached to any task in Asana. It exists in a single workspace or organization. Tags have some metadata associated with them, but it is possible that we will simplify them in the future so it is not encouraged to rely too heavily on it. Unlike projects, tags do not provide any ordering on the tasks they are associated with. - name: Tasks description: |- The task is the basic object around which many operations in Asana are centered. In the Asana application, multiple tasks populate the middle pane according to some view parameters, and the set of selected tasks determines the more detailed information presented in the details pane. Sections are unique in that they will be included in the `memberships` field of task objects returned in the API when the task is within a section. They can also be used to manipulate the ordering of a task within a project. [Queries](/reference/gettasks) return a [compact representation of each task object](/reference/tasks). To retrieve *all* fields or *specific set* of the fields, use [field selectors](/docs/inputoutput-options) to manipulate what data is included in a response. - name: Task templates description: |- A task template is an object that allows new tasks to be created with a predefined setup, which may include followers, dependencies, custom fields, etc. It simplifies the process of running a workflow that involves a similar set of work every time. Task templates are contained within a single project. - name: Teams description: A team is used to group related projects and people together within an organization. Each project in an organization is associated with a team. - name: Team memberships description: This object determines if a user is a member of a team. - name: Time periods description: "A time period is an object that represents a domain-scoped date range\ \ that can be set on [goals](/reference/goals)." - name: Typeahead description: The typeahead search API provides search for objects from a single workspace. - name: Users description: |- A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks. Like other objects in the system, users are referred to by numerical IDs. However, the special string identifier `me` can be used anywhere a user ID is accepted, to refer to the current authenticated user (e.g, `GET /users/me`). - name: User task lists description: "A user task list represents the tasks assigned to a particular user.\ \ This list is the user's [My Tasks](https://asana.com/guide/help/fundamentals/my-tasks)\ \ list." - name: Webhooks description: |- Webhooks allow you to subscribe to notifications about events that occur on Asana resources (e.g., tasks, projects, stories, etc.). For a more detailed explanation of webhooks see the [overview of webhooks](/docs/webhooks-guide). - name: Workspaces description: |- A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace. An *organization* is a special kind of workspace that represents a company. In an organization, you can group your projects into teams. You can read more about how organizations work on the Asana Guide. To tell if your workspace is an organization or not, check its `is_organization` property. Over time, we intend to migrate most workspaces into organizations and to release more organization-specific functionality. We may eventually deprecate using workspace-based APIs for organizations. Currently, and until after some reasonable grace period following any further announcements, you can still reference organizations in any `workspace` parameter. - name: Workspace memberships description: This object determines if a user is a member of a workspace. paths: /attachments/{attachmentGid}: get: tags: - Attachments summary: Get an attachment description: Get the full record for a single attachment. operationId: getAttachment parameters: - name: attachmentGid in: path description: Globally unique identifier for the attachment. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: attachment - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - connected_to_app - created_at - download_url - host - name - parent - parent.created_by - parent.name - parent.resource_subtype - permanent_url - resource_subtype - size - view_url example: - connected_to_app - created_at - download_url - host - name - parent - parent.created_by - parent.name - parent.resource_subtype - permanent_url - resource_subtype - size - view_url x-ballerina-name: optFields responses: "200": description: Successfully retrieved the record for a single attachment. content: application/json: schema: $ref: '#/components/schemas/InlineResponse200' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "402": description: "The request was valid, but the queried object or object mutation\ \ specified in the request is above your current premium level." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "424": description: "You have exceeded one of the enforced rate limits in the API.\ \ See the [documentation on rate limiting](https://developers.asana.com/docs/#rate-limits)\ \ for more information." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "501": description: There is an issue between the load balancers and Asana's API. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "503": description: "Either the upstream service is unavailable to the API, or\ \ the API has been intentionally shut off." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "504": description: This request took too long to complete. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Attachment result = client.attachments.getAttachment(attachmentGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet attachmentsApiInstance = new Asana.AttachmentsApi();\nlet attachment_gid\ \ = \"12345\"; // String | Globally unique identifier for the attachment.\n\ let opts = { \n 'opt_fields': \"connected_to_app,created_at,download_url,host,name,parent,parent.created_by,parent.name,parent.resource_subtype,permanent_url,resource_subtype,size,view_url\"\ \n};\nattachmentsApiInstance.getAttachment(attachment_gid, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.attachments.getAttachment(attachmentGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class attachments_api_instance = asana.AttachmentsApi(api_client) attachment_gid = "12345" # str | Globally unique identifier for the attachment. opts = { 'opt_fields': "connected_to_app,created_at,download_url,host,name,parent,parent.created_by,parent.name,parent.resource_subtype,permanent_url,resource_subtype,size,view_url", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get an attachment api_response = attachments_api_instance.get_attachment(attachment_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling AttachmentsApi->get_attachment: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.attachments.get_attachment(attachment_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- attachments->getAttachment($attachment_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.attachments.get_attachment(attachment_gid: 'attachment_gid', param: "value", param: "value", options: {pretty: true}) delete: tags: - Attachments summary: Delete an attachment description: |- Deletes a specific, existing attachment. Returns an empty data record. operationId: deleteAttachment parameters: - name: attachmentGid in: path description: Globally unique identifier for the attachment. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: attachment - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty responses: "200": description: Successfully deleted the specified attachment. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2001' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.attachments.deleteAttachment(attachmentGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: |- const Asana = require('asana'); let client = Asana.ApiClient.instance; let token = client.authentications['token']; token.accessToken = ''; let attachmentsApiInstance = new Asana.AttachmentsApi(); let attachment_gid = "12345"; // String | Globally unique identifier for the attachment. attachmentsApiInstance.deleteAttachment(attachment_gid).then((result) => { console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2)); }, (error) => { console.error(error.response.body); }); name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.attachments.deleteAttachment(attachmentGid) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class attachments_api_instance = asana.AttachmentsApi(api_client) attachment_gid = "12345" # str | Globally unique identifier for the attachment. try: # Delete an attachment api_response = attachments_api_instance.delete_attachment(attachment_gid) pprint(api_response) except ApiException as e: print("Exception when calling AttachmentsApi->delete_attachment: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.attachments.delete_attachment(attachment_gid, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- attachments->deleteAttachment($attachment_gid, array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.attachments.delete_attachment(attachment_gid: 'attachment_gid', options: {pretty: true}) /attachments: get: tags: - Attachments summary: Get attachments from an object description: |- Returns the compact records for all attachments on the object. There are three possible `parent` values for this request: `project`, `project_brief`, and `task`. For a project, an attachment refers to a file uploaded to the "Key resources" section in the project Overview. For a project brief, an attachment refers to inline files in the project brief itself. For a task, an attachment refers to a file directly associated to that task. Note that within the Asana app, inline images in the task description do not appear in the index of image thumbnails nor as stories in the task. However, requests made to `GET /attachments` for a task will return all of the images in the task, including inline images. operationId: getAttachmentsForObject parameters: - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: limit in: query description: |- Results per page. The number of objects to return per page. The value must be between 1 and 100. required: false style: form explode: true schema: maximum: 100 minimum: 1 type: integer example: 50 - name: offset in: query description: |- Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' required: false style: form explode: true schema: type: string example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 - name: parent in: query description: "Globally unique identifier for object to fetch statuses from.\ \ Must be a GID for a `project`, `project_brief`, or `task`." required: true style: form explode: true schema: type: string example: "159874" - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - connected_to_app - created_at - download_url - host - name - offset - parent - parent.created_by - parent.name - parent.resource_subtype - path - permanent_url - resource_subtype - size - uri - view_url example: - connected_to_app - created_at - download_url - host - name - offset - parent - parent.created_by - parent.name - parent.resource_subtype - path - permanent_url - resource_subtype - size - uri - view_url x-ballerina-name: optFields responses: "200": description: Successfully retrieved the specified object's attachments. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2002' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.attachments.getAttachmentsForObject(parent) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet attachmentsApiInstance = new Asana.AttachmentsApi();\nlet parent\ \ = \"159874\"; // String | Globally unique identifier for object to fetch\ \ statuses from. Must be a GID for a `project`, `project_brief`, or `task`.\n\ let opts = { \n 'limit': 50, \n 'offset': \"eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9\"\ , \n 'opt_fields': \"connected_to_app,created_at,download_url,host,name,offset,parent,parent.created_by,parent.name,parent.resource_subtype,path,permanent_url,resource_subtype,size,uri,view_url\"\ \n};\nattachmentsApiInstance.getAttachmentsForObject(parent, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.attachments.getAttachmentsForObject({param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class attachments_api_instance = asana.AttachmentsApi(api_client) parent = "159874" # str | Globally unique identifier for object to fetch statuses from. Must be a GID for a `project`, `project_brief`, or `task`. opts = { 'limit': 50, # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': "connected_to_app,created_at,download_url,host,name,offset,parent,parent.created_by,parent.name,parent.resource_subtype,path,permanent_url,resource_subtype,size,uri,view_url", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get attachments from an object api_response = attachments_api_instance.get_attachments_for_object(parent, opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling AttachmentsApi->get_attachments_for_object: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.attachments.get_attachments_for_object({'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- attachments->getAttachmentsForObject(array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.attachments.get_attachments_for_object(parent: ''parent_example'', param: "value", param: "value", options: {pretty: true}) post: tags: - Attachments summary: Upload an attachment description: |- Upload an attachment. This method uploads an attachment on an object and returns the compact record for the created attachment object. This is possible by either: - Providing the URL of the external resource being attached, or - Downloading the file content first and then uploading it as any other attachment. Note that it is not possible to attach files from third party services such as Dropbox, Box, Vimeo & Google Drive via the API The 100MB size limit on attachments in Asana is enforced on this endpoint. This endpoint expects a multipart/form-data encoded request containing the full contents of the file to be uploaded. Requests made should follow the HTTP/1.1 specification that line terminators are of the form `CRLF` or `\r\n` outlined [here](http://www.w3.org/Protocols/HTTP/1.1/draft-ietf-http-v11-spec-01#Basic-Rules) in order for the server to reliably and properly handle the request. operationId: createAttachmentForObject parameters: - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - connected_to_app - created_at - download_url - host - name - parent - parent.created_by - parent.name - parent.resource_subtype - permanent_url - resource_subtype - size - view_url example: - connected_to_app - created_at - download_url - host - name - parent - parent.created_by - parent.name - parent.resource_subtype - permanent_url - resource_subtype - size - view_url x-ballerina-name: optFields requestBody: description: |- The file you want to upload. *Note when using curl:* Be sure to add an `‘@’` before the file path, and use the `--form` option instead of the `-d` option. When uploading PDFs with curl, force the content-type to be pdf by appending the content type to the file path: `--form "file=@file.pdf;type=application/pdf"`. content: multipart/form-data: schema: $ref: '#/components/schemas/AttachmentRequest' responses: "200": description: Successfully uploaded the attachment to the parent object. content: application/json: schema: $ref: '#/components/schemas/InlineResponse200' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Attachment result = client.attachments.createAttachmentForObject(file, parent, url, name) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\nconst fs = require(\"fs\");\n\n\ let client = Asana.ApiClient.instance;\nlet token = client.authentications['token'];\n\ token.accessToken = '';\n\nlet attachmentsApiInstance\ \ = new Asana.AttachmentsApi();\nlet opts = { \n 'resource_subtype':\ \ \"external\", \n 'file': fs.createReadStream(\"file_example\"), \n\ \ 'parent': \"parent_example\", \n 'url': \"url_example\", \n \ \ 'name': \"name_example\", \n 'connect_to_app': true, \n 'opt_fields':\ \ \"connected_to_app,created_at,download_url,host,name,parent,parent.created_by,parent.name,parent.resource_subtype,permanent_url,resource_subtype,size,view_url\"\ \n};\nattachmentsApiInstance.createAttachmentForObject(opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: python install: pip install asana code: "import asana\nfrom asana.rest import ApiException\nfrom pprint import\ \ pprint\n\nconfiguration = asana.Configuration()\nconfiguration.access_token\ \ = ''\napi_client = asana.ApiClient(configuration)\n\ \n# create an instance of the API class\nattachments_api_instance = asana.AttachmentsApi(api_client)\n\ opts = {\n 'resource_subtype': \"external\", # str | \n 'file':\ \ \"file_example\", # str | \n 'parent': \"parent_example\", # str\ \ | \n 'url': \"url_example\", # str | \n 'name': \"name_example\"\ , # str | \n 'connect_to_app': True, # bool | \n 'opt_fields': \"\ connected_to_app,created_at,download_url,host,name,parent,parent.created_by,parent.name,parent.resource_subtype,permanent_url,resource_subtype,size,view_url\"\ , # list[str] | This endpoint returns a compact resource, which excludes\ \ some properties by default. To include those optional properties, set\ \ this query parameter to a comma-separated list of the properties you\ \ wish to include.\n}\n\ntry:\n # Upload an attachment\n api_response\ \ = attachments_api_instance.create_attachment_for_object(opts)\n pprint(api_response)\n\ except ApiException as e:\n print(\"Exception when calling AttachmentsApi->create_attachment_for_object:\ \ %s\\n\" % e)" name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.attachments.create_attachment_for_object({'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- attachments->createAttachmentForObject(array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.attachments.create_attachment_for_object(field: "value", field: "value", options: {pretty: true}) /workspaces/{workspaceGid}/audit_log_events: get: tags: - Audit log API summary: Get audit log events description: |- Retrieve the audit log events that have been captured in your domain. This endpoint will return a list of [AuditLogEvent](/reference/audit-log-api) objects, sorted by creation time in ascending order. Note that the Audit Log API captures events from October 8th, 2021 and later. Queries for events before this date will not return results. There are a number of query parameters (below) that can be used to filter the set of [AuditLogEvent](/reference/audit-log-api) objects that are returned in the response. Any combination of query parameters is valid. When no filters are provided, all of the events that have been captured in your domain will match. The list of events will always be [paginated](/docs/pagination). The default limit is 1000 events. The next set of events can be retrieved using the `offset` from the previous response. If there are no events that match the provided filters in your domain, the endpoint will return `null` for the `next_page` field. Querying again with the same filters may return new events if they were captured after the last request. Once a response includes a `next_page` with an `offset`, subsequent requests can be made with the latest `offset` to poll for new events that match the provided filters. *Note: If the filters you provided match events in your domain and `next_page` is present in the response, we will continue to send `next_page` on subsequent requests even when there are no more events that match the filters. This was put in place so that you can implement an audit log stream that will return future events that match these filters. If you are not interested in future events that match the filters you have defined, you can rely on checking empty `data` response for the end of current events that match your filters.* When no `offset` is provided, the response will begin with the oldest events that match the provided filters. It is important to note that [AuditLogEvent](/reference/audit-log-api) objects will be permanently deleted from our systems after 90 days. If you wish to keep a permanent record of these events, we recommend using a SIEM tool to ingest and store these logs. operationId: getAuditLogEvents parameters: - name: workspaceGid in: path description: Globally unique identifier for the workspace or organization. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: workspace - name: start_at in: query description: Filter to events created after this time (inclusive). required: false style: form explode: true schema: type: string format: date-time x-ballerina-name: startAt - name: end_at in: query description: Filter to events created before this time (exclusive). required: false style: form explode: true schema: type: string format: date-time x-ballerina-name: endAt - name: event_type in: query description: |- Filter to events of this type. Refer to the [supported audit log events](/docs/audit-log-events#supported-audit-log-events) for a full list of values. required: false style: form explode: true schema: type: string x-ballerina-name: eventType - name: actor_type in: query description: |- Filter to events with an actor of this type. This only needs to be included if querying for actor types without an ID. If `actor_gid` is included, this should be excluded. required: false style: form explode: true schema: type: string enum: - user - asana - asana_support - anonymous - external_administrator x-ballerina-name: actorType - name: actor_gid in: query description: Filter to events triggered by the actor with this ID. required: false style: form explode: true schema: type: string x-ballerina-name: actorGid - name: resource_gid in: query description: Filter to events with this resource ID. required: false style: form explode: true schema: type: string x-ballerina-name: resourceGid - name: limit in: query description: |- Results per page. The number of objects to return per page. The value must be between 1 and 100. required: false style: form explode: true schema: maximum: 100 minimum: 1 type: integer example: 50 - name: offset in: query description: |- Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' required: false style: form explode: true schema: type: string example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 responses: "200": description: AuditLogEvents were successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2003' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.auditlogapi.getAuditLogEvents(workspaceGid, resourceGid, actorGid, actorType, eventType, endAt, startAt) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet auditLogApiApiInstance = new Asana.AuditLogAPIApi();\nlet workspace_gid\ \ = \"12345\"; // String | Globally unique identifier for the workspace\ \ or organization.\nlet opts = { \n 'start_at': \"2013-10-20T19:20:30+01:00\"\ , \n 'end_at': \"2013-10-20T19:20:30+01:00\", \n 'event_type': \"\ event_type_example\", \n 'actor_type': \"actor_type_example\", \n \ \ 'actor_gid': \"actor_gid_example\", \n 'resource_gid': \"resource_gid_example\"\ , \n 'limit': 50, \n 'offset': \"eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9\"\ \n};\nauditLogApiApiInstance.getAuditLogEvents(workspace_gid, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.auditlogapi.getAuditLogEvents(workspaceGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class audit_log_api_api_instance = asana.AuditLogAPIApi(api_client) workspace_gid = "12345" # str | Globally unique identifier for the workspace or organization. opts = { 'start_at': '2013-10-20T19:20:30+01:00', # datetime | Filter to events created after this time (inclusive). 'end_at': '2013-10-20T19:20:30+01:00', # datetime | Filter to events created before this time (exclusive). 'event_type': "event_type_example", # str | Filter to events of this type. Refer to the [supported audit log events](/docs/audit-log-events#supported-audit-log-events) for a full list of values. 'actor_type': "actor_type_example", # str | Filter to events with an actor of this type. This only needs to be included if querying for actor types without an ID. If `actor_gid` is included, this should be excluded. 'actor_gid': "actor_gid_example", # str | Filter to events triggered by the actor with this ID. 'resource_gid': "resource_gid_example", # str | Filter to events with this resource ID. 'limit': 50, # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' } try: # Get audit log events api_response = audit_log_api_api_instance.get_audit_log_events(workspace_gid, opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling AuditLogAPIApi->get_audit_log_events: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.audit_log_api.get_audit_log_events(workspace_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- auditlogapi->getAuditLogEvents($workspace_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.audit_log_api.get_audit_log_events(workspace_gid: 'workspace_gid', param: "value", param: "value", options: {pretty: true}) /batch: post: tags: - Batch API summary: Submit parallel requests description: Make multiple requests in parallel to Asana's API. operationId: createBatchRequest parameters: - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - body - headers - status_code example: - body - headers - status_code x-ballerina-name: optFields requestBody: description: The requests to batch together via the Batch API. content: application/json: schema: $ref: '#/components/schemas/BatchBody' required: true responses: "200": description: Successfully completed the requested batch API operations. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2004' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.batchapi.createBatchRequest() .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet batchApiApiInstance = new Asana.BatchAPIApi();\nlet body = {\"data\"\ : {\"\": \"\", \"\": \"\",}}; // Object\ \ | The requests to batch together via the Batch API.\nlet opts = { \n\ \ 'opt_fields': \"body,headers,status_code\"\n};\nbatchApiApiInstance.createBatchRequest(body,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.batchapi.createBatchRequest({field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class batch_api_api_instance = asana.BatchAPIApi(api_client) body = {"data": {"": "", "": "",}} # dict | The requests to batch together via the Batch API. opts = { 'opt_fields': "body,headers,status_code", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Submit parallel requests api_response = batch_api_api_instance.create_batch_request(body, opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling BatchAPIApi->create_batch_request: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.batch_api.create_batch_request({'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- batchapi->createBatchRequest(array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.batch_api.create_batch_request(field: "value", field: "value", options: {pretty: true}) /projects/{projectGid}/custom_field_settings: get: tags: - Custom field settings summary: Get a project's custom fields description: "Returns a list of all of the custom fields settings on a project,\ \ in compact form. Note that, as in all queries to collections which return\ \ compact representation, `opt_fields` can be used to include more data than\ \ is returned in the compact representation. See the [documentation for input/output\ \ options](https://developers.asana.com/docs/inputoutput-options) for more\ \ information." operationId: getCustomFieldSettingsForProject parameters: - name: projectGid in: path description: Globally unique identifier for the project. required: true style: simple explode: false schema: type: string example: "1331" x-env-variable: project - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: limit in: query description: |- Results per page. The number of objects to return per page. The value must be between 1 and 100. required: false style: form explode: true schema: maximum: 100 minimum: 1 type: integer example: 50 - name: offset in: query description: |- Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' required: false style: form explode: true schema: type: string example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - custom_field - custom_field.asana_created_field - custom_field.created_by - custom_field.created_by.name - custom_field.currency_code - custom_field.custom_label - custom_field.custom_label_position - custom_field.date_value - custom_field.date_value.date - custom_field.date_value.date_time - custom_field.description - custom_field.display_value - custom_field.enabled - custom_field.enum_options - custom_field.enum_options.color - custom_field.enum_options.enabled - custom_field.enum_options.name - custom_field.enum_value - custom_field.enum_value.color - custom_field.enum_value.enabled - custom_field.enum_value.name - custom_field.format - custom_field.has_notifications_enabled - custom_field.id_prefix - custom_field.is_formula_field - custom_field.is_global_to_workspace - custom_field.is_value_read_only - custom_field.multi_enum_values - custom_field.multi_enum_values.color - custom_field.multi_enum_values.enabled - custom_field.multi_enum_values.name - custom_field.name - custom_field.number_value - custom_field.people_value - custom_field.people_value.name - custom_field.precision - custom_field.representation_type - custom_field.resource_subtype - custom_field.text_value - custom_field.type - is_important - offset - parent - parent.name - path - project - project.name - uri example: - custom_field - custom_field.asana_created_field - custom_field.created_by - custom_field.created_by.name - custom_field.currency_code - custom_field.custom_label - custom_field.custom_label_position - custom_field.date_value - custom_field.date_value.date - custom_field.date_value.date_time - custom_field.description - custom_field.display_value - custom_field.enabled - custom_field.enum_options - custom_field.enum_options.color - custom_field.enum_options.enabled - custom_field.enum_options.name - custom_field.enum_value - custom_field.enum_value.color - custom_field.enum_value.enabled - custom_field.enum_value.name - custom_field.format - custom_field.has_notifications_enabled - custom_field.id_prefix - custom_field.is_formula_field - custom_field.is_global_to_workspace - custom_field.is_value_read_only - custom_field.multi_enum_values - custom_field.multi_enum_values.color - custom_field.multi_enum_values.enabled - custom_field.multi_enum_values.name - custom_field.name - custom_field.number_value - custom_field.people_value - custom_field.people_value.name - custom_field.precision - custom_field.representation_type - custom_field.resource_subtype - custom_field.text_value - custom_field.type - is_important - offset - parent - parent.name - path - project - project.name - uri x-ballerina-name: optFields responses: "200": description: Successfully retrieved custom field settings objects for a project. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2005' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.customfieldsettings.getCustomFieldSettingsForProject(projectGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet customFieldSettingsApiInstance = new Asana.CustomFieldSettingsApi();\n\ let project_gid = \"1331\"; // String | Globally unique identifier for\ \ the project.\nlet opts = { \n 'limit': 50, \n 'offset': \"eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9\"\ , \n 'opt_fields': \"custom_field,custom_field.asana_created_field,custom_field.created_by,custom_field.created_by.name,custom_field.currency_code,custom_field.custom_label,custom_field.custom_label_position,custom_field.date_value,custom_field.date_value.date,custom_field.date_value.date_time,custom_field.description,custom_field.display_value,custom_field.enabled,custom_field.enum_options,custom_field.enum_options.color,custom_field.enum_options.enabled,custom_field.enum_options.name,custom_field.enum_value,custom_field.enum_value.color,custom_field.enum_value.enabled,custom_field.enum_value.name,custom_field.format,custom_field.has_notifications_enabled,custom_field.is_formula_field,custom_field.is_global_to_workspace,custom_field.is_value_read_only,custom_field.multi_enum_values,custom_field.multi_enum_values.color,custom_field.multi_enum_values.enabled,custom_field.multi_enum_values.name,custom_field.name,custom_field.number_value,custom_field.people_value,custom_field.people_value.name,custom_field.precision,custom_field.resource_subtype,custom_field.text_value,custom_field.type,is_important,offset,parent,parent.name,path,project,project.name,uri\"\ \n};\ncustomFieldSettingsApiInstance.getCustomFieldSettingsForProject(project_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfieldsettings.getCustomFieldSettingsForProject(projectGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class custom_field_settings_api_instance = asana.CustomFieldSettingsApi(api_client) project_gid = "1331" # str | Globally unique identifier for the project. opts = { 'limit': 50, # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': "custom_field,custom_field.asana_created_field,custom_field.created_by,custom_field.created_by.name,custom_field.currency_code,custom_field.custom_label,custom_field.custom_label_position,custom_field.date_value,custom_field.date_value.date,custom_field.date_value.date_time,custom_field.description,custom_field.display_value,custom_field.enabled,custom_field.enum_options,custom_field.enum_options.color,custom_field.enum_options.enabled,custom_field.enum_options.name,custom_field.enum_value,custom_field.enum_value.color,custom_field.enum_value.enabled,custom_field.enum_value.name,custom_field.format,custom_field.has_notifications_enabled,custom_field.id_prefix,custom_field.is_formula_field,custom_field.is_global_to_workspace,custom_field.is_value_read_only,custom_field.multi_enum_values,custom_field.multi_enum_values.color,custom_field.multi_enum_values.enabled,custom_field.multi_enum_values.name,custom_field.name,custom_field.number_value,custom_field.people_value,custom_field.people_value.name,custom_field.precision,custom_field.representation_type,custom_field.resource_subtype,custom_field.text_value,custom_field.type,is_important,offset,parent,parent.name,path,project,project.name,uri", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get a project's custom fields api_response = custom_field_settings_api_instance.get_custom_field_settings_for_project(project_gid, opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling CustomFieldSettingsApi->get_custom_field_settings_for_project: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_field_settings.get_custom_field_settings_for_project(project_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- customfieldsettings->getCustomFieldSettingsForProject($project_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_field_settings.get_custom_field_settings_for_project(project_gid: 'project_gid', param: "value", param: "value", options: {pretty: true}) /portfolios/{portfolioGid}/custom_field_settings: get: tags: - Custom field settings summary: Get a portfolio's custom fields description: "Returns a list of all of the custom fields settings on a portfolio,\ \ in compact form." operationId: getCustomFieldSettingsForPortfolio parameters: - name: portfolioGid in: path description: Globally unique identifier for the portfolio. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: portfolio - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: limit in: query description: |- Results per page. The number of objects to return per page. The value must be between 1 and 100. required: false style: form explode: true schema: maximum: 100 minimum: 1 type: integer example: 50 - name: offset in: query description: |- Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' required: false style: form explode: true schema: type: string example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - custom_field - custom_field.asana_created_field - custom_field.created_by - custom_field.created_by.name - custom_field.currency_code - custom_field.custom_label - custom_field.custom_label_position - custom_field.date_value - custom_field.date_value.date - custom_field.date_value.date_time - custom_field.description - custom_field.display_value - custom_field.enabled - custom_field.enum_options - custom_field.enum_options.color - custom_field.enum_options.enabled - custom_field.enum_options.name - custom_field.enum_value - custom_field.enum_value.color - custom_field.enum_value.enabled - custom_field.enum_value.name - custom_field.format - custom_field.has_notifications_enabled - custom_field.id_prefix - custom_field.is_formula_field - custom_field.is_global_to_workspace - custom_field.is_value_read_only - custom_field.multi_enum_values - custom_field.multi_enum_values.color - custom_field.multi_enum_values.enabled - custom_field.multi_enum_values.name - custom_field.name - custom_field.number_value - custom_field.people_value - custom_field.people_value.name - custom_field.precision - custom_field.representation_type - custom_field.resource_subtype - custom_field.text_value - custom_field.type - is_important - offset - parent - parent.name - path - project - project.name - uri example: - custom_field - custom_field.asana_created_field - custom_field.created_by - custom_field.created_by.name - custom_field.currency_code - custom_field.custom_label - custom_field.custom_label_position - custom_field.date_value - custom_field.date_value.date - custom_field.date_value.date_time - custom_field.description - custom_field.display_value - custom_field.enabled - custom_field.enum_options - custom_field.enum_options.color - custom_field.enum_options.enabled - custom_field.enum_options.name - custom_field.enum_value - custom_field.enum_value.color - custom_field.enum_value.enabled - custom_field.enum_value.name - custom_field.format - custom_field.has_notifications_enabled - custom_field.id_prefix - custom_field.is_formula_field - custom_field.is_global_to_workspace - custom_field.is_value_read_only - custom_field.multi_enum_values - custom_field.multi_enum_values.color - custom_field.multi_enum_values.enabled - custom_field.multi_enum_values.name - custom_field.name - custom_field.number_value - custom_field.people_value - custom_field.people_value.name - custom_field.precision - custom_field.representation_type - custom_field.resource_subtype - custom_field.text_value - custom_field.type - is_important - offset - parent - parent.name - path - project - project.name - uri x-ballerina-name: optFields responses: "200": description: Successfully retrieved custom field settings objects for a portfolio. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2005' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.customfieldsettings.getCustomFieldSettingsForPortfolio(portfolioGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet customFieldSettingsApiInstance = new Asana.CustomFieldSettingsApi();\n\ let portfolio_gid = \"12345\"; // String | Globally unique identifier\ \ for the portfolio.\nlet opts = { \n 'limit': 50, \n 'offset':\ \ \"eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9\", \n 'opt_fields': \"custom_field,custom_field.asana_created_field,custom_field.created_by,custom_field.created_by.name,custom_field.currency_code,custom_field.custom_label,custom_field.custom_label_position,custom_field.date_value,custom_field.date_value.date,custom_field.date_value.date_time,custom_field.description,custom_field.display_value,custom_field.enabled,custom_field.enum_options,custom_field.enum_options.color,custom_field.enum_options.enabled,custom_field.enum_options.name,custom_field.enum_value,custom_field.enum_value.color,custom_field.enum_value.enabled,custom_field.enum_value.name,custom_field.format,custom_field.has_notifications_enabled,custom_field.is_formula_field,custom_field.is_global_to_workspace,custom_field.is_value_read_only,custom_field.multi_enum_values,custom_field.multi_enum_values.color,custom_field.multi_enum_values.enabled,custom_field.multi_enum_values.name,custom_field.name,custom_field.number_value,custom_field.people_value,custom_field.people_value.name,custom_field.precision,custom_field.resource_subtype,custom_field.text_value,custom_field.type,is_important,offset,parent,parent.name,path,project,project.name,uri\"\ \n};\ncustomFieldSettingsApiInstance.getCustomFieldSettingsForPortfolio(portfolio_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfieldsettings.getCustomFieldSettingsForPortfolio(portfolioGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class custom_field_settings_api_instance = asana.CustomFieldSettingsApi(api_client) portfolio_gid = "12345" # str | Globally unique identifier for the portfolio. opts = { 'limit': 50, # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': "custom_field,custom_field.asana_created_field,custom_field.created_by,custom_field.created_by.name,custom_field.currency_code,custom_field.custom_label,custom_field.custom_label_position,custom_field.date_value,custom_field.date_value.date,custom_field.date_value.date_time,custom_field.description,custom_field.display_value,custom_field.enabled,custom_field.enum_options,custom_field.enum_options.color,custom_field.enum_options.enabled,custom_field.enum_options.name,custom_field.enum_value,custom_field.enum_value.color,custom_field.enum_value.enabled,custom_field.enum_value.name,custom_field.format,custom_field.has_notifications_enabled,custom_field.id_prefix,custom_field.is_formula_field,custom_field.is_global_to_workspace,custom_field.is_value_read_only,custom_field.multi_enum_values,custom_field.multi_enum_values.color,custom_field.multi_enum_values.enabled,custom_field.multi_enum_values.name,custom_field.name,custom_field.number_value,custom_field.people_value,custom_field.people_value.name,custom_field.precision,custom_field.representation_type,custom_field.resource_subtype,custom_field.text_value,custom_field.type,is_important,offset,parent,parent.name,path,project,project.name,uri", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get a portfolio's custom fields api_response = custom_field_settings_api_instance.get_custom_field_settings_for_portfolio(portfolio_gid, opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling CustomFieldSettingsApi->get_custom_field_settings_for_portfolio: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_field_settings.get_custom_field_settings_for_portfolio(portfolio_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- customfieldsettings->getCustomFieldSettingsForPortfolio($portfolio_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_field_settings.get_custom_field_settings_for_portfolio(portfolio_gid: 'portfolio_gid', param: "value", param: "value", options: {pretty: true}) /custom_fields: post: tags: - Custom fields summary: Create a custom field description: |- Creates a new custom field in a workspace. Every custom field is required to be created in a specific workspace, and this workspace cannot be changed once set. A custom field’s name must be unique within a workspace and not conflict with names of existing task properties such as `Due Date` or `Assignee`. A custom field’s type must be one of `text`, `enum`, `multi_enum`, `number`, `date`, or `people`. Returns the full record of the newly created custom field. operationId: createCustomField parameters: - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - asana_created_field - created_by - created_by.name - currency_code - custom_label - custom_label_position - date_value - date_value.date - date_value.date_time - description - display_value - enabled - enum_options - enum_options.color - enum_options.enabled - enum_options.name - enum_value - enum_value.color - enum_value.enabled - enum_value.name - format - has_notifications_enabled - id_prefix - is_formula_field - is_global_to_workspace - is_value_read_only - multi_enum_values - multi_enum_values.color - multi_enum_values.enabled - multi_enum_values.name - name - number_value - people_value - people_value.name - precision - representation_type - resource_subtype - text_value - type example: - asana_created_field - created_by - created_by.name - currency_code - custom_label - custom_label_position - date_value - date_value.date - date_value.date_time - description - display_value - enabled - enum_options - enum_options.color - enum_options.enabled - enum_options.name - enum_value - enum_value.color - enum_value.enabled - enum_value.name - format - has_notifications_enabled - id_prefix - is_formula_field - is_global_to_workspace - is_value_read_only - multi_enum_values - multi_enum_values.color - multi_enum_values.enabled - multi_enum_values.name - name - number_value - people_value - people_value.name - precision - representation_type - resource_subtype - text_value - type x-ballerina-name: optFields requestBody: description: The custom field object to create. content: application/json: schema: $ref: '#/components/schemas/CustomFieldsBody' required: true responses: "201": description: Custom field successfully created. content: application/json: schema: $ref: '#/components/schemas/InlineResponse201' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); CustomField result = client.customfields.createCustomField() .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet customFieldsApiInstance = new Asana.CustomFieldsApi();\nlet body\ \ = {\"data\": {\"\": \"\", \"\": \"\"\ ,}}; // Object | The custom field object to create.\nlet opts = { \n \ \ 'opt_fields': \"asana_created_field,created_by,created_by.name,currency_code,custom_label,custom_label_position,date_value,date_value.date,date_value.date_time,description,display_value,enabled,enum_options,enum_options.color,enum_options.enabled,enum_options.name,enum_value,enum_value.color,enum_value.enabled,enum_value.name,format,has_notifications_enabled,is_formula_field,is_global_to_workspace,is_value_read_only,multi_enum_values,multi_enum_values.color,multi_enum_values.enabled,multi_enum_values.name,name,number_value,people_value,people_value.name,precision,resource_subtype,text_value,type\"\ \n};\ncustomFieldsApiInstance.createCustomField(body, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfields.createCustomField({field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class custom_fields_api_instance = asana.CustomFieldsApi(api_client) body = {"data": {"": "", "": "",}} # dict | The custom field object to create. opts = { 'opt_fields': "asana_created_field,created_by,created_by.name,currency_code,custom_label,custom_label_position,date_value,date_value.date,date_value.date_time,description,display_value,enabled,enum_options,enum_options.color,enum_options.enabled,enum_options.name,enum_value,enum_value.color,enum_value.enabled,enum_value.name,format,has_notifications_enabled,id_prefix,is_formula_field,is_global_to_workspace,is_value_read_only,multi_enum_values,multi_enum_values.color,multi_enum_values.enabled,multi_enum_values.name,name,number_value,people_value,people_value.name,precision,representation_type,resource_subtype,text_value,type", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Create a custom field api_response = custom_fields_api_instance.create_custom_field(body, opts) pprint(api_response) except ApiException as e: print("Exception when calling CustomFieldsApi->create_custom_field: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_fields.create_custom_field({'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- customfields->createCustomField(array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_fields.create_custom_field(field: "value", field: "value", options: {pretty: true}) /custom_fields/{customFieldGid}: get: tags: - Custom fields summary: Get a custom field description: |- Get the complete definition of a custom field’s metadata. Since custom fields can be defined for one of a number of types, and these types have different data and behaviors, there are fields that are relevant to a particular type. For instance, as noted above, enum_options is only relevant for the enum type and defines the set of choices that the enum could represent. The examples below show some of these type-specific custom field definitions. operationId: getCustomField parameters: - name: customFieldGid in: path description: Globally unique identifier for the custom field. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: custom_field - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - asana_created_field - created_by - created_by.name - currency_code - custom_label - custom_label_position - date_value - date_value.date - date_value.date_time - description - display_value - enabled - enum_options - enum_options.color - enum_options.enabled - enum_options.name - enum_value - enum_value.color - enum_value.enabled - enum_value.name - format - has_notifications_enabled - id_prefix - is_formula_field - is_global_to_workspace - is_value_read_only - multi_enum_values - multi_enum_values.color - multi_enum_values.enabled - multi_enum_values.name - name - number_value - people_value - people_value.name - precision - representation_type - resource_subtype - text_value - type example: - asana_created_field - created_by - created_by.name - currency_code - custom_label - custom_label_position - date_value - date_value.date - date_value.date_time - description - display_value - enabled - enum_options - enum_options.color - enum_options.enabled - enum_options.name - enum_value - enum_value.color - enum_value.enabled - enum_value.name - format - has_notifications_enabled - id_prefix - is_formula_field - is_global_to_workspace - is_value_read_only - multi_enum_values - multi_enum_values.color - multi_enum_values.enabled - multi_enum_values.name - name - number_value - people_value - people_value.name - precision - representation_type - resource_subtype - text_value - type x-ballerina-name: optFields responses: "200": description: Successfully retrieved the complete definition of a custom field’s metadata. content: application/json: schema: $ref: '#/components/schemas/InlineResponse201' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); CustomField result = client.customfields.getCustomField(customFieldGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet customFieldsApiInstance = new Asana.CustomFieldsApi();\nlet custom_field_gid\ \ = \"12345\"; // String | Globally unique identifier for the custom field.\n\ let opts = { \n 'opt_fields': \"asana_created_field,created_by,created_by.name,currency_code,custom_label,custom_label_position,date_value,date_value.date,date_value.date_time,description,display_value,enabled,enum_options,enum_options.color,enum_options.enabled,enum_options.name,enum_value,enum_value.color,enum_value.enabled,enum_value.name,format,has_notifications_enabled,is_formula_field,is_global_to_workspace,is_value_read_only,multi_enum_values,multi_enum_values.color,multi_enum_values.enabled,multi_enum_values.name,name,number_value,people_value,people_value.name,precision,resource_subtype,text_value,type\"\ \n};\ncustomFieldsApiInstance.getCustomField(custom_field_gid, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfields.getCustomField(customFieldGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class custom_fields_api_instance = asana.CustomFieldsApi(api_client) custom_field_gid = "12345" # str | Globally unique identifier for the custom field. opts = { 'opt_fields': "asana_created_field,created_by,created_by.name,currency_code,custom_label,custom_label_position,date_value,date_value.date,date_value.date_time,description,display_value,enabled,enum_options,enum_options.color,enum_options.enabled,enum_options.name,enum_value,enum_value.color,enum_value.enabled,enum_value.name,format,has_notifications_enabled,id_prefix,is_formula_field,is_global_to_workspace,is_value_read_only,multi_enum_values,multi_enum_values.color,multi_enum_values.enabled,multi_enum_values.name,name,number_value,people_value,people_value.name,precision,representation_type,resource_subtype,text_value,type", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get a custom field api_response = custom_fields_api_instance.get_custom_field(custom_field_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling CustomFieldsApi->get_custom_field: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_fields.get_custom_field(custom_field_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- customfields->getCustomField($custom_field_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_fields.get_custom_field(custom_field_gid: 'custom_field_gid', param: "value", param: "value", options: {pretty: true}) put: tags: - Custom fields summary: Update a custom field description: |- A specific, existing custom field can be updated by making a PUT request on the URL for that custom field. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the custom field. A custom field’s `type` cannot be updated. An enum custom field’s `enum_options` cannot be updated with this endpoint. Instead see “Work With Enum Options” for information on how to update `enum_options`. Locked custom fields can only be updated by the user who locked the field. Returns the complete updated custom field record. operationId: updateCustomField parameters: - name: customFieldGid in: path description: Globally unique identifier for the custom field. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: custom_field - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - asana_created_field - created_by - created_by.name - currency_code - custom_label - custom_label_position - date_value - date_value.date - date_value.date_time - description - display_value - enabled - enum_options - enum_options.color - enum_options.enabled - enum_options.name - enum_value - enum_value.color - enum_value.enabled - enum_value.name - format - has_notifications_enabled - id_prefix - is_formula_field - is_global_to_workspace - is_value_read_only - multi_enum_values - multi_enum_values.color - multi_enum_values.enabled - multi_enum_values.name - name - number_value - people_value - people_value.name - precision - representation_type - resource_subtype - text_value - type example: - asana_created_field - created_by - created_by.name - currency_code - custom_label - custom_label_position - date_value - date_value.date - date_value.date_time - description - display_value - enabled - enum_options - enum_options.color - enum_options.enabled - enum_options.name - enum_value - enum_value.color - enum_value.enabled - enum_value.name - format - has_notifications_enabled - id_prefix - is_formula_field - is_global_to_workspace - is_value_read_only - multi_enum_values - multi_enum_values.color - multi_enum_values.enabled - multi_enum_values.name - name - number_value - people_value - people_value.name - precision - representation_type - resource_subtype - text_value - type x-ballerina-name: optFields requestBody: description: The custom field object with all updated properties. content: application/json: schema: $ref: '#/components/schemas/CustomFieldscustomFieldGidBody' responses: "200": description: The custom field was successfully updated. content: application/json: schema: $ref: '#/components/schemas/InlineResponse201' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); CustomField result = client.customfields.updateCustomField(customFieldGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet customFieldsApiInstance = new Asana.CustomFieldsApi();\nlet custom_field_gid\ \ = \"12345\"; // String | Globally unique identifier for the custom field.\n\ let opts = { \n 'body': {\"data\": {\"\": \"\", \"\ \": \"\",}}, \n 'opt_fields': \"asana_created_field,created_by,created_by.name,currency_code,custom_label,custom_label_position,date_value,date_value.date,date_value.date_time,description,display_value,enabled,enum_options,enum_options.color,enum_options.enabled,enum_options.name,enum_value,enum_value.color,enum_value.enabled,enum_value.name,format,has_notifications_enabled,is_formula_field,is_global_to_workspace,is_value_read_only,multi_enum_values,multi_enum_values.color,multi_enum_values.enabled,multi_enum_values.name,name,number_value,people_value,people_value.name,precision,resource_subtype,text_value,type\"\ \n};\ncustomFieldsApiInstance.updateCustomField(custom_field_gid, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfields.updateCustomField(customFieldGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class custom_fields_api_instance = asana.CustomFieldsApi(api_client) custom_field_gid = "12345" # str | Globally unique identifier for the custom field. opts = { 'body': {"data": {"": "", "": "",}}, # dict | The custom field object with all updated properties. 'opt_fields': "asana_created_field,created_by,created_by.name,currency_code,custom_label,custom_label_position,date_value,date_value.date,date_value.date_time,description,display_value,enabled,enum_options,enum_options.color,enum_options.enabled,enum_options.name,enum_value,enum_value.color,enum_value.enabled,enum_value.name,format,has_notifications_enabled,id_prefix,is_formula_field,is_global_to_workspace,is_value_read_only,multi_enum_values,multi_enum_values.color,multi_enum_values.enabled,multi_enum_values.name,name,number_value,people_value,people_value.name,precision,representation_type,resource_subtype,text_value,type", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Update a custom field api_response = custom_fields_api_instance.update_custom_field(custom_field_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling CustomFieldsApi->update_custom_field: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_fields.update_custom_field(custom_field_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- customfields->updateCustomField($custom_field_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_fields.update_custom_field(custom_field_gid: 'custom_field_gid', field: "value", field: "value", options: {pretty: true}) delete: tags: - Custom fields summary: Delete a custom field description: |- A specific, existing custom field can be deleted by making a DELETE request on the URL for that custom field. Locked custom fields can only be deleted by the user who locked the field. Returns an empty data record. operationId: deleteCustomField parameters: - name: customFieldGid in: path description: Globally unique identifier for the custom field. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: custom_field - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty responses: "200": description: The custom field was successfully deleted. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2001' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.customfields.deleteCustomField(customFieldGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: |- const Asana = require('asana'); let client = Asana.ApiClient.instance; let token = client.authentications['token']; token.accessToken = ''; let customFieldsApiInstance = new Asana.CustomFieldsApi(); let custom_field_gid = "12345"; // String | Globally unique identifier for the custom field. customFieldsApiInstance.deleteCustomField(custom_field_gid).then((result) => { console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2)); }, (error) => { console.error(error.response.body); }); name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfields.deleteCustomField(customFieldGid) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class custom_fields_api_instance = asana.CustomFieldsApi(api_client) custom_field_gid = "12345" # str | Globally unique identifier for the custom field. try: # Delete a custom field api_response = custom_fields_api_instance.delete_custom_field(custom_field_gid) pprint(api_response) except ApiException as e: print("Exception when calling CustomFieldsApi->delete_custom_field: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_fields.delete_custom_field(custom_field_gid, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- customfields->deleteCustomField($custom_field_gid, array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_fields.delete_custom_field(custom_field_gid: 'custom_field_gid', options: {pretty: true}) /workspaces/{workspaceGid}/custom_fields: get: tags: - Custom fields summary: Get a workspace's custom fields description: Returns a list of the compact representation of all of the custom fields in a workspace. operationId: getCustomFieldsForWorkspace parameters: - name: workspaceGid in: path description: Globally unique identifier for the workspace or organization. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: workspace - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: limit in: query description: |- Results per page. The number of objects to return per page. The value must be between 1 and 100. required: false style: form explode: true schema: maximum: 100 minimum: 1 type: integer example: 50 - name: offset in: query description: |- Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' required: false style: form explode: true schema: type: string example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - asana_created_field - created_by - created_by.name - currency_code - custom_label - custom_label_position - date_value - date_value.date - date_value.date_time - description - display_value - enabled - enum_options - enum_options.color - enum_options.enabled - enum_options.name - enum_value - enum_value.color - enum_value.enabled - enum_value.name - format - has_notifications_enabled - id_prefix - is_formula_field - is_global_to_workspace - is_value_read_only - multi_enum_values - multi_enum_values.color - multi_enum_values.enabled - multi_enum_values.name - name - number_value - offset - path - people_value - people_value.name - precision - representation_type - resource_subtype - text_value - type - uri example: - asana_created_field - created_by - created_by.name - currency_code - custom_label - custom_label_position - date_value - date_value.date - date_value.date_time - description - display_value - enabled - enum_options - enum_options.color - enum_options.enabled - enum_options.name - enum_value - enum_value.color - enum_value.enabled - enum_value.name - format - has_notifications_enabled - id_prefix - is_formula_field - is_global_to_workspace - is_value_read_only - multi_enum_values - multi_enum_values.color - multi_enum_values.enabled - multi_enum_values.name - name - number_value - offset - path - people_value - people_value.name - precision - representation_type - resource_subtype - text_value - type - uri x-ballerina-name: optFields responses: "200": description: Successfully retrieved all custom fields for the given workspace. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2006' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.customfields.getCustomFieldsForWorkspace(workspaceGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet customFieldsApiInstance = new Asana.CustomFieldsApi();\nlet workspace_gid\ \ = \"12345\"; // String | Globally unique identifier for the workspace\ \ or organization.\nlet opts = { \n 'limit': 50, \n 'offset': \"\ eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9\", \n 'opt_fields': \"asana_created_field,created_by,created_by.name,currency_code,custom_label,custom_label_position,date_value,date_value.date,date_value.date_time,description,display_value,enabled,enum_options,enum_options.color,enum_options.enabled,enum_options.name,enum_value,enum_value.color,enum_value.enabled,enum_value.name,format,has_notifications_enabled,is_formula_field,is_global_to_workspace,is_value_read_only,multi_enum_values,multi_enum_values.color,multi_enum_values.enabled,multi_enum_values.name,name,number_value,offset,path,people_value,people_value.name,precision,resource_subtype,text_value,type,uri\"\ \n};\ncustomFieldsApiInstance.getCustomFieldsForWorkspace(workspace_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfields.getCustomFieldsForWorkspace(workspaceGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class custom_fields_api_instance = asana.CustomFieldsApi(api_client) workspace_gid = "12345" # str | Globally unique identifier for the workspace or organization. opts = { 'limit': 50, # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': "asana_created_field,created_by,created_by.name,currency_code,custom_label,custom_label_position,date_value,date_value.date,date_value.date_time,description,display_value,enabled,enum_options,enum_options.color,enum_options.enabled,enum_options.name,enum_value,enum_value.color,enum_value.enabled,enum_value.name,format,has_notifications_enabled,id_prefix,is_formula_field,is_global_to_workspace,is_value_read_only,multi_enum_values,multi_enum_values.color,multi_enum_values.enabled,multi_enum_values.name,name,number_value,offset,path,people_value,people_value.name,precision,representation_type,resource_subtype,text_value,type,uri", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get a workspace's custom fields api_response = custom_fields_api_instance.get_custom_fields_for_workspace(workspace_gid, opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling CustomFieldsApi->get_custom_fields_for_workspace: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_fields.get_custom_fields_for_workspace(workspace_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- customfields->getCustomFieldsForWorkspace($workspace_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_fields.get_custom_fields_for_workspace(workspace_gid: 'workspace_gid', param: "value", param: "value", options: {pretty: true}) /custom_fields/{customFieldGid}/enum_options: post: tags: - Custom fields summary: Create an enum option description: |- Creates an enum option and adds it to this custom field’s list of enum options. A custom field can have at most 500 enum options (including disabled options). By default new enum options are inserted at the end of a custom field’s list. Locked custom fields can only have enum options added by the user who locked the field. Returns the full record of the newly created enum option. operationId: createEnumOptionForCustomField parameters: - name: customFieldGid in: path description: Globally unique identifier for the custom field. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: custom_field - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - color - enabled - name example: - color - enabled - name x-ballerina-name: optFields requestBody: description: The enum option object to create. content: application/json: schema: $ref: '#/components/schemas/CustomFieldGidEnumOptionsBody' responses: "201": description: Custom field enum option successfully created. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2011' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.customfields.createEnumOptionForCustomField(customFieldGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet customFieldsApiInstance = new Asana.CustomFieldsApi();\nlet custom_field_gid\ \ = \"12345\"; // String | Globally unique identifier for the custom field.\n\ let opts = { \n 'body': {\"data\": {\"\": \"\", \"\ \": \"\",}}, \n 'opt_fields': \"color,enabled,name\"\ \n};\ncustomFieldsApiInstance.createEnumOptionForCustomField(custom_field_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfields.createEnumOptionForCustomField(customFieldGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class custom_fields_api_instance = asana.CustomFieldsApi(api_client) custom_field_gid = "12345" # str | Globally unique identifier for the custom field. opts = { 'body': {"data": {"": "", "": "",}}, # dict | The enum option object to create. 'opt_fields': "color,enabled,name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Create an enum option api_response = custom_fields_api_instance.create_enum_option_for_custom_field(custom_field_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling CustomFieldsApi->create_enum_option_for_custom_field: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_fields.create_enum_option_for_custom_field(custom_field_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- customfields->createEnumOptionForCustomField($custom_field_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_fields.create_enum_option_for_custom_field(custom_field_gid: 'custom_field_gid', field: "value", field: "value", options: {pretty: true}) /custom_fields/{customFieldGid}/enum_options/insert: post: tags: - Custom fields summary: Reorder a custom field's enum description: |- Moves a particular enum option to be either before or after another specified enum option in the custom field. Locked custom fields can only be reordered by the user who locked the field. operationId: insertEnumOptionForCustomField parameters: - name: customFieldGid in: path description: Globally unique identifier for the custom field. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: custom_field - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - color - enabled - name example: - color - enabled - name x-ballerina-name: optFields requestBody: description: The enum option object to create. content: application/json: schema: $ref: '#/components/schemas/EnumOptionsInsertBody' responses: "200": description: Custom field enum option successfully reordered. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2011' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.customfields.insertEnumOptionForCustomField(customFieldGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet customFieldsApiInstance = new Asana.CustomFieldsApi();\nlet custom_field_gid\ \ = \"12345\"; // String | Globally unique identifier for the custom field.\n\ let opts = { \n 'body': {\"data\": {\"\": \"\", \"\ \": \"\",}}, \n 'opt_fields': \"color,enabled,name\"\ \n};\ncustomFieldsApiInstance.insertEnumOptionForCustomField(custom_field_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfields.insertEnumOptionForCustomField(customFieldGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class custom_fields_api_instance = asana.CustomFieldsApi(api_client) custom_field_gid = "12345" # str | Globally unique identifier for the custom field. opts = { 'body': {"data": {"": "", "": "",}}, # dict | The enum option object to create. 'opt_fields': "color,enabled,name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Reorder a custom field's enum api_response = custom_fields_api_instance.insert_enum_option_for_custom_field(custom_field_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling CustomFieldsApi->insert_enum_option_for_custom_field: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_fields.insert_enum_option_for_custom_field(custom_field_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- customfields->insertEnumOptionForCustomField($custom_field_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_fields.insert_enum_option_for_custom_field(custom_field_gid: 'custom_field_gid', field: "value", field: "value", options: {pretty: true}) /enum_options/{enumOptionGid}: put: tags: - Custom fields summary: Update an enum option description: |- Updates an existing enum option. Enum custom fields require at least one enabled enum option. Locked custom fields can only be updated by the user who locked the field. Returns the full record of the updated enum option. operationId: updateEnumOption parameters: - name: enumOptionGid in: path description: Globally unique identifier for the enum option. required: true style: simple explode: false schema: type: string example: "124578" - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - color - enabled - name example: - color - enabled - name x-ballerina-name: optFields requestBody: description: The enum option object to update content: application/json: schema: $ref: '#/components/schemas/EnumOptionsenumOptionGidBody' responses: "200": description: Successfully updated the specified custom field enum. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2011' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.customfields.updateEnumOption(enumOptionGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet customFieldsApiInstance = new Asana.CustomFieldsApi();\nlet enum_option_gid\ \ = \"124578\"; // String | Globally unique identifier for the enum option.\n\ let opts = { \n 'body': {\"data\": {\"\": \"\", \"\ \": \"\",}}, \n 'opt_fields': \"color,enabled,name\"\ \n};\ncustomFieldsApiInstance.updateEnumOption(enum_option_gid, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.customfields.updateEnumOption(enumOptionGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class custom_fields_api_instance = asana.CustomFieldsApi(api_client) enum_option_gid = "124578" # str | Globally unique identifier for the enum option. opts = { 'body': {"data": {"": "", "": "",}}, # dict | The enum option object to update 'opt_fields': "color,enabled,name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Update an enum option api_response = custom_fields_api_instance.update_enum_option(enum_option_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling CustomFieldsApi->update_enum_option: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.custom_fields.update_enum_option(enum_option_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- customfields->updateEnumOption($enum_option_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.custom_fields.update_enum_option(enum_option_gid: 'enum_option_gid', field: "value", field: "value", options: {pretty: true}) /events: get: tags: - Events summary: Get events on a resource description: |- Returns the full record for all events that have occurred since the sync token was created. A `GET` request to the endpoint `/[path_to_resource]/events` can be made in lieu of including the resource ID in the data for the request. Asana limits a single sync token to 100 events. If more than 100 events exist for a given resource, `has_more: true` will be returned in the response, indicating that there are more events to pull. *Note: The resource returned will be the resource that triggered the event. This may be different from the one that the events were requested for. For example, a subscription to a project will contain events for tasks contained within the project.* operationId: getEvents parameters: - name: resource in: query description: "A resource ID to subscribe to. The resource can be a task, project,\ \ or goal." required: true style: form explode: true schema: type: string example: "12345" - name: sync in: query description: |- A sync token received from the last request, or none on first sync. Events will be returned from the point in time that the sync token was generated. *Note: On your first request, omit the sync token. The response will be the same as for an expired sync token, and will include a new valid sync token.If the sync token is too old (which may happen from time to time) the API will return a `412 Precondition Failed` error, and include a fresh sync token in the response.* required: false style: form explode: true schema: type: string example: de4774f6915eae04714ca93bb2f5ee81 - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - action - change - change.action - change.added_value - change.field - change.new_value - change.removed_value - created_at - parent - parent.name - resource - resource.name - type - user - user.name example: - action - change - change.action - change.added_value - change.field - change.new_value - change.removed_value - created_at - parent - parent.name - resource - resource.name - type - user - user.name x-ballerina-name: optFields responses: "200": description: Successfully retrieved events. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2007' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "412": description: The request is missing or has an expired sync token. content: application/json: schema: $ref: '#/components/schemas/InlineResponse412' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.events.getEvents(sync, resource) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet eventsApiInstance = new Asana.EventsApi();\nlet resource = \"12345\"\ ; // String | A resource ID to subscribe to. The resource can be a task\ \ or project.\nlet opts = { \n 'sync': \"de4774f6915eae04714ca93bb2f5ee81\"\ , \n 'opt_fields': \"action,change,change.action,change.added_value,change.field,change.new_value,change.removed_value,created_at,parent,parent.name,resource,resource.name,type,user,user.name\"\ \n};\neventsApiInstance.getEvents(resource, opts).then((result) => {\n\ \ console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.events.getEvents({param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class events_api_instance = asana.EventsApi(api_client) resource = "12345" # str | A resource ID to subscribe to. The resource can be a task, project, or goal. opts = { 'sync': "de4774f6915eae04714ca93bb2f5ee81", # str | A sync token received from the last request, or none on first sync. Events will be returned from the point in time that the sync token was generated. *Note: On your first request, omit the sync token. The response will be the same as for an expired sync token, and will include a new valid sync token.If the sync token is too old (which may happen from time to time) the API will return a `412 Precondition Failed` error, and include a fresh sync token in the response.* 'opt_fields': "action,change,change.action,change.added_value,change.field,change.new_value,change.removed_value,created_at,parent,parent.name,resource,resource.name,type,user,user.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get events on a resource api_response = events_api_instance.get_events(resource, opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling EventsApi->get_events: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.events.get_events({'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- events->getEvents(array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.events.get_events(resource: ''resource_example'', param: "value", param: "value", options: {pretty: true}) /goal_relationships/{goalRelationshipGid}: get: tags: - Goal relationships summary: Get a goal relationship description: Returns the complete updated goal relationship record for a single goal relationship. operationId: getGoalRelationship parameters: - name: goalRelationshipGid in: path description: Globally unique identifier for the goal relationship. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: goal_relationship - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - contribution_weight - resource_subtype - supported_goal - supported_goal.name - supported_goal.owner - supported_goal.owner.name - supporting_resource - supporting_resource.name example: - contribution_weight - resource_subtype - supported_goal - supported_goal.name - supported_goal.owner - supported_goal.owner.name - supporting_resource - supporting_resource.name x-ballerina-name: optFields responses: "200": description: Successfully retrieved the record for the goal relationship. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2008' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goalrelationships.getGoalRelationship(goalRelationshipGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet goalRelationshipsApiInstance = new Asana.GoalRelationshipsApi();\n\ let goal_relationship_gid = \"12345\"; // String | Globally unique identifier\ \ for the goal relationship.\nlet opts = { \n 'opt_fields': \"contribution_weight,resource_subtype,supported_goal,supported_goal.name,supported_goal.owner,supported_goal.owner.name,supporting_resource,supporting_resource.name\"\ \n};\ngoalRelationshipsApiInstance.getGoalRelationship(goal_relationship_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class goal_relationships_api_instance = asana.GoalRelationshipsApi(api_client) goal_relationship_gid = "12345" # str | Globally unique identifier for the goal relationship. opts = { 'opt_fields': "contribution_weight,resource_subtype,supported_goal,supported_goal.name,supported_goal.owner,supported_goal.owner.name,supporting_resource,supporting_resource.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get a goal relationship api_response = goal_relationships_api_instance.get_goal_relationship(goal_relationship_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling GoalRelationshipsApi->get_goal_relationship: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goal_relationships.get_goal_relationship(goal_relationship_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- goalrelationships->getGoalRelationship($goal_relationship_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goal_relationships.get_goal_relationship(goal_relationship_gid: 'goal_relationship_gid', param: "value", param: "value", options: {pretty: true}) put: tags: - Goal relationships summary: Update a goal relationship description: |- An existing goal relationship can be updated by making a PUT request on the URL for that goal relationship. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Returns the complete updated goal relationship record. operationId: updateGoalRelationship parameters: - name: goalRelationshipGid in: path description: Globally unique identifier for the goal relationship. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: goal_relationship - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - contribution_weight - resource_subtype - supported_goal - supported_goal.name - supported_goal.owner - supported_goal.owner.name - supporting_resource - supporting_resource.name example: - contribution_weight - resource_subtype - supported_goal - supported_goal.name - supported_goal.owner - supported_goal.owner.name - supporting_resource - supporting_resource.name x-ballerina-name: optFields requestBody: description: The updated fields for the goal relationship. content: application/json: schema: $ref: '#/components/schemas/GoalRelationshipsgoalRelationshipGidBody' required: true responses: "200": description: Successfully updated the goal relationship. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2008' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goalrelationships.updateGoalRelationship(goalRelationshipGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet goalRelationshipsApiInstance = new Asana.GoalRelationshipsApi();\n\ let body = {\"data\": {\"\": \"\", \"\": \"\ \",}}; // Object | The updated fields for the goal relationship.\n\ let goal_relationship_gid = \"12345\"; // String | Globally unique identifier\ \ for the goal relationship.\nlet opts = { \n 'opt_fields': \"contribution_weight,resource_subtype,supported_goal,supported_goal.name,supported_goal.owner,supported_goal.owner.name,supporting_resource,supporting_resource.name\"\ \n};\ngoalRelationshipsApiInstance.updateGoalRelationship(body, goal_relationship_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class goal_relationships_api_instance = asana.GoalRelationshipsApi(api_client) body = {"data": {"": "", "": "",}} # dict | The updated fields for the goal relationship. goal_relationship_gid = "12345" # str | Globally unique identifier for the goal relationship. opts = { 'opt_fields': "contribution_weight,resource_subtype,supported_goal,supported_goal.name,supported_goal.owner,supported_goal.owner.name,supporting_resource,supporting_resource.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Update a goal relationship api_response = goal_relationships_api_instance.update_goal_relationship(body, goal_relationship_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling GoalRelationshipsApi->update_goal_relationship: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goal_relationships.update_goal_relationship(goal_relationship_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- goalrelationships->updateGoalRelationship($goal_relationship_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goal_relationships.update_goal_relationship(goal_relationship_gid: 'goal_relationship_gid', field: "value", field: "value", options: {pretty: true}) /goal_relationships: get: tags: - Goal relationships summary: Get goal relationships description: Returns compact goal relationship records. operationId: getGoalRelationships parameters: - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: limit in: query description: |- Results per page. The number of objects to return per page. The value must be between 1 and 100. required: false style: form explode: true schema: maximum: 100 minimum: 1 type: integer example: 50 - name: offset in: query description: |- Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' required: false style: form explode: true schema: type: string example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 - name: supported_goal in: query description: Globally unique identifier for the supported goal in the goal relationship. required: true style: form explode: true schema: type: string example: "12345" x-ballerina-name: supportedGoal - name: resource_subtype in: query description: "If provided, filter to goal relationships with a given resource_subtype." required: false style: form explode: true schema: type: string example: subgoal x-ballerina-name: resourceSubtype - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - contribution_weight - offset - path - resource_subtype - supported_goal - supported_goal.name - supported_goal.owner - supported_goal.owner.name - supporting_resource - supporting_resource.name - uri example: - contribution_weight - offset - path - resource_subtype - supported_goal - supported_goal.name - supported_goal.owner - supported_goal.owner.name - supporting_resource - supporting_resource.name - uri x-ballerina-name: optFields responses: "200": description: Successfully retrieved the requested goal relationships. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2009' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.goalrelationships.getGoalRelationships(resourceSubtype, supportedGoal) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet goalRelationshipsApiInstance = new Asana.GoalRelationshipsApi();\n\ let supported_goal = \"12345\"; // String | Globally unique identifier\ \ for the supported goal in the goal relationship.\nlet opts = { \n \ \ 'limit': 50, \n 'offset': \"eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9\"\ , \n 'resource_subtype': \"subgoal\", \n 'opt_fields': \"contribution_weight,offset,path,resource_subtype,supported_goal,supported_goal.name,supported_goal.owner,supported_goal.owner.name,supporting_resource,supporting_resource.name,uri\"\ \n};\ngoalRelationshipsApiInstance.getGoalRelationships(supported_goal,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class goal_relationships_api_instance = asana.GoalRelationshipsApi(api_client) supported_goal = "12345" # str | Globally unique identifier for the supported goal in the goal relationship. opts = { 'limit': 50, # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'resource_subtype': "subgoal", # str | If provided, filter to goal relationships with a given resource_subtype. 'opt_fields': "contribution_weight,offset,path,resource_subtype,supported_goal,supported_goal.name,supported_goal.owner,supported_goal.owner.name,supporting_resource,supporting_resource.name,uri", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get goal relationships api_response = goal_relationships_api_instance.get_goal_relationships(supported_goal, opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling GoalRelationshipsApi->get_goal_relationships: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goal_relationships.get_goal_relationships({'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- goalrelationships->getGoalRelationships(array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goal_relationships.get_goal_relationships(supported_goal: ''supported_goal_example'', param: "value", param: "value", options: {pretty: true}) /goals/{goalGid}/addSupportingRelationship: post: tags: - Goal relationships summary: Add a supporting goal relationship description: |- Creates a goal relationship by adding a supporting resource to a given goal. Returns the newly created goal relationship record. operationId: addSupportingRelationship parameters: - name: goalGid in: path description: Globally unique identifier for the goal. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: goal - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - contribution_weight - resource_subtype - supported_goal - supported_goal.name - supported_goal.owner - supported_goal.owner.name - supporting_resource - supporting_resource.name example: - contribution_weight - resource_subtype - supported_goal - supported_goal.name - supported_goal.owner - supported_goal.owner.name - supporting_resource - supporting_resource.name x-ballerina-name: optFields requestBody: description: The supporting resource to be added to the goal content: application/json: schema: $ref: '#/components/schemas/GoalGidAddSupportingRelationshipBody' required: true responses: "200": description: Successfully created the goal relationship. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2008' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goalrelationships.addSupportingRelationship(goalGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet goalRelationshipsApiInstance = new Asana.GoalRelationshipsApi();\n\ let body = {\"data\": {\"\": \"\", \"\": \"\ \",}}; // Object | The supporting resource to be added to the\ \ goal\nlet goal_gid = \"12345\"; // String | Globally unique identifier\ \ for the goal.\nlet opts = { \n 'opt_fields': \"contribution_weight,resource_subtype,supported_goal,supported_goal.name,supported_goal.owner,supported_goal.owner.name,supporting_resource,supporting_resource.name\"\ \n};\ngoalRelationshipsApiInstance.addSupportingRelationship(body, goal_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class goal_relationships_api_instance = asana.GoalRelationshipsApi(api_client) body = {"data": {"": "", "": "",}} # dict | The supporting resource to be added to the goal goal_gid = "12345" # str | Globally unique identifier for the goal. opts = { 'opt_fields': "contribution_weight,resource_subtype,supported_goal,supported_goal.name,supported_goal.owner,supported_goal.owner.name,supporting_resource,supporting_resource.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Add a supporting goal relationship api_response = goal_relationships_api_instance.add_supporting_relationship(body, goal_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling GoalRelationshipsApi->add_supporting_relationship: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goal_relationships.add_supporting_relationship(goal_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- goalrelationships->addSupportingRelationship($goal_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goal_relationships.add_supporting_relationship(goal_gid: 'goal_gid', field: "value", field: "value", options: {pretty: true}) /goals/{goalGid}/removeSupportingRelationship: post: tags: - Goal relationships summary: Removes a supporting goal relationship description: Removes a goal relationship for a given parent goal. operationId: removeSupportingRelationship parameters: - name: goalGid in: path description: Globally unique identifier for the goal. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: goal - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty requestBody: description: The supporting resource to be removed from the goal content: application/json: schema: $ref: '#/components/schemas/GoalGidRemoveSupportingRelationshipBody' required: true responses: "200": description: Successfully removed the goal relationship. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2001' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goalrelationships.removeSupportingRelationship(goalGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: |- const Asana = require('asana'); let client = Asana.ApiClient.instance; let token = client.authentications['token']; token.accessToken = ''; let goalRelationshipsApiInstance = new Asana.GoalRelationshipsApi(); let body = {"data": {"": "", "": "",}}; // Object | The supporting resource to be removed from the goal let goal_gid = "12345"; // String | Globally unique identifier for the goal. goalRelationshipsApiInstance.removeSupportingRelationship(body, goal_gid).then((result) => { console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2)); }, (error) => { console.error(error.response.body); }); name: node-sdk-v3 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class goal_relationships_api_instance = asana.GoalRelationshipsApi(api_client) body = {"data": {"": "", "": "",}} # dict | The supporting resource to be removed from the goal goal_gid = "12345" # str | Globally unique identifier for the goal. try: # Removes a supporting goal relationship api_response = goal_relationships_api_instance.remove_supporting_relationship(body, goal_gid) pprint(api_response) except ApiException as e: print("Exception when calling GoalRelationshipsApi->remove_supporting_relationship: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goal_relationships.remove_supporting_relationship(goal_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- goalrelationships->removeSupportingRelationship($goal_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goal_relationships.remove_supporting_relationship(goal_gid: 'goal_gid', field: "value", field: "value", options: {pretty: true}) /goals/{goalGid}: get: tags: - Goals summary: Get a goal description: Returns the complete goal record for a single goal. operationId: getGoal parameters: - name: goalGid in: path description: Globally unique identifier for the goal. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: goal - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name example: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name x-ballerina-name: optFields responses: "200": description: Successfully retrieved the record for a single goal. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20010' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "402": description: "The request was valid, but the queried object or object mutation\ \ specified in the request is above your current premium level." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goals.getGoal(goalGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet goalsApiInstance = new Asana.GoalsApi();\nlet goal_gid = \"12345\"\ ; // String | Globally unique identifier for the goal.\nlet opts = { \n\ \ 'opt_fields': \"current_status_update,current_status_update.resource_subtype,current_status_update.title,due_on,followers,followers.name,html_notes,is_workspace_level,liked,likes,likes.user,likes.user.name,metric,metric.can_manage,metric.currency_code,metric.current_display_value,metric.current_number_value,metric.initial_number_value,metric.precision,metric.progress_source,metric.resource_subtype,metric.target_number_value,metric.unit,name,notes,num_likes,owner,owner.name,start_on,status,team,team.name,time_period,time_period.display_name,time_period.end_on,time_period.period,time_period.start_on,workspace,workspace.name\"\ \n};\ngoalsApiInstance.getGoal(goal_gid, opts).then((result) => {\n \ \ console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.getGoal(goalGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class goals_api_instance = asana.GoalsApi(api_client) goal_gid = "12345" # str | Globally unique identifier for the goal. opts = { 'opt_fields': "current_status_update,current_status_update.resource_subtype,current_status_update.title,due_on,followers,followers.name,html_notes,is_workspace_level,liked,likes,likes.user,likes.user.name,metric,metric.can_manage,metric.currency_code,metric.current_display_value,metric.current_number_value,metric.initial_number_value,metric.precision,metric.progress_source,metric.resource_subtype,metric.target_number_value,metric.unit,name,notes,num_likes,owner,owner.name,start_on,status,team,team.name,time_period,time_period.display_name,time_period.end_on,time_period.period,time_period.start_on,workspace,workspace.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get a goal api_response = goals_api_instance.get_goal(goal_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling GoalsApi->get_goal: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.get_goal(goal_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- goals->getGoal($goal_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.get_goal(goal_gid: 'goal_gid', param: "value", param: "value", options: {pretty: true}) put: tags: - Goals summary: Update a goal description: |- An existing goal can be updated by making a PUT request on the URL for that goal. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Returns the complete updated goal record. operationId: updateGoal parameters: - name: goalGid in: path description: Globally unique identifier for the goal. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: goal - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name example: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name x-ballerina-name: optFields requestBody: description: The updated fields for the goal. content: application/json: schema: $ref: '#/components/schemas/GoalsgoalGidBody' required: true responses: "200": description: Successfully updated the goal. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20010' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goals.updateGoal(goalGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet goalsApiInstance = new Asana.GoalsApi();\nlet body = {\"data\":\ \ {\"\": \"\", \"\": \"\",}}; // Object\ \ | The updated fields for the goal.\nlet goal_gid = \"12345\"; // String\ \ | Globally unique identifier for the goal.\nlet opts = { \n 'opt_fields':\ \ \"current_status_update,current_status_update.resource_subtype,current_status_update.title,due_on,followers,followers.name,html_notes,is_workspace_level,liked,likes,likes.user,likes.user.name,metric,metric.can_manage,metric.currency_code,metric.current_display_value,metric.current_number_value,metric.initial_number_value,metric.precision,metric.progress_source,metric.resource_subtype,metric.target_number_value,metric.unit,name,notes,num_likes,owner,owner.name,start_on,status,team,team.name,time_period,time_period.display_name,time_period.end_on,time_period.period,time_period.start_on,workspace,workspace.name\"\ \n};\ngoalsApiInstance.updateGoal(body, goal_gid, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.updateGoal(goalGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class goals_api_instance = asana.GoalsApi(api_client) body = {"data": {"": "", "": "",}} # dict | The updated fields for the goal. goal_gid = "12345" # str | Globally unique identifier for the goal. opts = { 'opt_fields': "current_status_update,current_status_update.resource_subtype,current_status_update.title,due_on,followers,followers.name,html_notes,is_workspace_level,liked,likes,likes.user,likes.user.name,metric,metric.can_manage,metric.currency_code,metric.current_display_value,metric.current_number_value,metric.initial_number_value,metric.precision,metric.progress_source,metric.resource_subtype,metric.target_number_value,metric.unit,name,notes,num_likes,owner,owner.name,start_on,status,team,team.name,time_period,time_period.display_name,time_period.end_on,time_period.period,time_period.start_on,workspace,workspace.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Update a goal api_response = goals_api_instance.update_goal(body, goal_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling GoalsApi->update_goal: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.update_goal(goal_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- goals->updateGoal($goal_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.update_goal(goal_gid: 'goal_gid', field: "value", field: "value", options: {pretty: true}) delete: tags: - Goals summary: Delete a goal description: |- A specific, existing goal can be deleted by making a DELETE request on the URL for that goal. Returns an empty data record. operationId: deleteGoal parameters: - name: goalGid in: path description: Globally unique identifier for the goal. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: goal - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty responses: "200": description: Successfully deleted the specified goal. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2001' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "402": description: "The request was valid, but the queried object or object mutation\ \ specified in the request is above your current premium level." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goals.deleteGoal(goalGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: |- const Asana = require('asana'); let client = Asana.ApiClient.instance; let token = client.authentications['token']; token.accessToken = ''; let goalsApiInstance = new Asana.GoalsApi(); let goal_gid = "12345"; // String | Globally unique identifier for the goal. goalsApiInstance.deleteGoal(goal_gid).then((result) => { console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2)); }, (error) => { console.error(error.response.body); }); name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.deleteGoal(goalGid) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class goals_api_instance = asana.GoalsApi(api_client) goal_gid = "12345" # str | Globally unique identifier for the goal. try: # Delete a goal api_response = goals_api_instance.delete_goal(goal_gid) pprint(api_response) except ApiException as e: print("Exception when calling GoalsApi->delete_goal: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.delete_goal(goal_gid, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- goals->deleteGoal($goal_gid, array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.delete_goal(goal_gid: 'goal_gid', options: {pretty: true}) /goals: get: tags: - Goals summary: Get goals description: Returns compact goal records. operationId: getGoals parameters: - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: portfolio in: query description: Globally unique identifier for supporting portfolio. required: false style: form explode: true schema: type: string example: "159874" - name: project in: query description: Globally unique identifier for supporting project. required: false style: form explode: true schema: type: string example: "512241" - name: task in: query description: Globally unique identifier for supporting task. required: false style: form explode: true schema: type: string example: "78424" - name: is_workspace_level in: query description: Filter to goals with is_workspace_level set to query value. Must be used with the workspace parameter. required: false style: form explode: true schema: type: boolean example: false x-ballerina-name: isWorkspaceLevel - name: team in: query description: Globally unique identifier for the team. required: false style: form explode: true schema: type: string example: "31326" - name: workspace in: query description: Globally unique identifier for the workspace. required: false style: form explode: true schema: type: string example: "31326" - name: time_periods in: query description: Globally unique identifiers for the time periods. required: false style: form explode: true schema: type: array items: type: string example: "221693,506165" x-ballerina-name: timePeriods - name: limit in: query description: |- Results per page. The number of objects to return per page. The value must be between 1 and 100. required: false style: form explode: true schema: maximum: 100 minimum: 1 type: integer example: 50 - name: offset in: query description: |- Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' required: false style: form explode: true schema: type: string example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - offset - owner - owner.name - path - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - uri - workspace - workspace.name example: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - offset - owner - owner.name - path - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - uri - workspace - workspace.name x-ballerina-name: optFields responses: "200": description: Successfully retrieved the requested goals. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20011' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "402": description: "The request was valid, but the queried object or object mutation\ \ specified in the request is above your current premium level." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.goals.getGoals(timePeriods, workspace, team, isWorkspaceLevel, project, portfolio) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet goalsApiInstance = new Asana.GoalsApi();\nlet opts = { \n 'portfolio':\ \ \"159874\", \n 'project': \"512241\", \n 'task': \"78424\", \n\ \ 'is_workspace_level': false, \n 'team': \"31326\", \n 'workspace':\ \ \"31326\", \n 'time_periods': \"221693,506165\", \n 'limit': 50,\ \ \n 'offset': \"eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9\", \n 'opt_fields':\ \ \"current_status_update,current_status_update.resource_subtype,current_status_update.title,due_on,followers,followers.name,html_notes,is_workspace_level,liked,likes,likes.user,likes.user.name,metric,metric.can_manage,metric.currency_code,metric.current_display_value,metric.current_number_value,metric.initial_number_value,metric.precision,metric.progress_source,metric.resource_subtype,metric.target_number_value,metric.unit,name,notes,num_likes,offset,owner,owner.name,path,start_on,status,team,team.name,time_period,time_period.display_name,time_period.end_on,time_period.period,time_period.start_on,uri,workspace,workspace.name\"\ \n};\ngoalsApiInstance.getGoals(opts).then((result) => {\n console.log('API\ \ called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.getGoals({param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class goals_api_instance = asana.GoalsApi(api_client) opts = { 'portfolio': "159874", # str | Globally unique identifier for supporting portfolio. 'project': "512241", # str | Globally unique identifier for supporting project. 'task': "78424", # str | Globally unique identifier for supporting task. 'is_workspace_level': False, # bool | Filter to goals with is_workspace_level set to query value. Must be used with the workspace parameter. 'team': "31326", # str | Globally unique identifier for the team. 'workspace': "31326", # str | Globally unique identifier for the workspace. 'time_periods': "221693,506165", # list[str] | Globally unique identifiers for the time periods. 'limit': 50, # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': "current_status_update,current_status_update.resource_subtype,current_status_update.title,due_on,followers,followers.name,html_notes,is_workspace_level,liked,likes,likes.user,likes.user.name,metric,metric.can_manage,metric.currency_code,metric.current_display_value,metric.current_number_value,metric.initial_number_value,metric.precision,metric.progress_source,metric.resource_subtype,metric.target_number_value,metric.unit,name,notes,num_likes,offset,owner,owner.name,path,start_on,status,team,team.name,time_period,time_period.display_name,time_period.end_on,time_period.period,time_period.start_on,uri,workspace,workspace.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get goals api_response = goals_api_instance.get_goals(opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling GoalsApi->get_goals: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.get_goals({'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- goals->getGoals(array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.get_goals(param: "value", param: "value", options: {pretty: true}) post: tags: - Goals summary: Create a goal description: |- Creates a new goal in a workspace or team. Returns the full record of the newly created goal. operationId: createGoal parameters: - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name example: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name x-ballerina-name: optFields requestBody: description: The goal to create. content: application/json: schema: $ref: '#/components/schemas/GoalsBody' required: true responses: "201": description: Successfully created a new goal. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20010' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "402": description: "The request was valid, but the queried object or object mutation\ \ specified in the request is above your current premium level." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goals.createGoal() .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet goalsApiInstance = new Asana.GoalsApi();\nlet body = {\"data\":\ \ {\"\": \"\", \"\": \"\",}}; // Object\ \ | The goal to create.\nlet opts = { \n 'opt_fields': \"current_status_update,current_status_update.resource_subtype,current_status_update.title,due_on,followers,followers.name,html_notes,is_workspace_level,liked,likes,likes.user,likes.user.name,metric,metric.can_manage,metric.currency_code,metric.current_display_value,metric.current_number_value,metric.initial_number_value,metric.precision,metric.progress_source,metric.resource_subtype,metric.target_number_value,metric.unit,name,notes,num_likes,owner,owner.name,start_on,status,team,team.name,time_period,time_period.display_name,time_period.end_on,time_period.period,time_period.start_on,workspace,workspace.name\"\ \n};\ngoalsApiInstance.createGoal(body, opts).then((result) => {\n \ \ console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.createGoal({field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class goals_api_instance = asana.GoalsApi(api_client) body = {"data": {"": "", "": "",}} # dict | The goal to create. opts = { 'opt_fields': "current_status_update,current_status_update.resource_subtype,current_status_update.title,due_on,followers,followers.name,html_notes,is_workspace_level,liked,likes,likes.user,likes.user.name,metric,metric.can_manage,metric.currency_code,metric.current_display_value,metric.current_number_value,metric.initial_number_value,metric.precision,metric.progress_source,metric.resource_subtype,metric.target_number_value,metric.unit,name,notes,num_likes,owner,owner.name,start_on,status,team,team.name,time_period,time_period.display_name,time_period.end_on,time_period.period,time_period.start_on,workspace,workspace.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Create a goal api_response = goals_api_instance.create_goal(body, opts) pprint(api_response) except ApiException as e: print("Exception when calling GoalsApi->create_goal: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.create_goal({'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- goals->createGoal(array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.create_goal(field: "value", field: "value", options: {pretty: true}) /goals/{goalGid}/setMetric: post: tags: - Goals summary: Create a goal metric description: Creates and adds a goal metric to a specified goal. Note that this replaces an existing goal metric if one already exists. operationId: createGoalMetric parameters: - name: goalGid in: path description: Globally unique identifier for the goal. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: goal - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name example: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name x-ballerina-name: optFields requestBody: description: The goal metric to create. content: application/json: schema: $ref: '#/components/schemas/GoalGidSetMetricBody' required: true responses: "200": description: Successfully created a new goal metric. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20010' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "402": description: "The request was valid, but the queried object or object mutation\ \ specified in the request is above your current premium level." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goals.createGoalMetric(goalGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet goalsApiInstance = new Asana.GoalsApi();\nlet body = {\"data\":\ \ {\"\": \"\", \"\": \"\",}}; // Object\ \ | The goal metric to create.\nlet goal_gid = \"12345\"; // String |\ \ Globally unique identifier for the goal.\nlet opts = { \n 'opt_fields':\ \ \"current_status_update,current_status_update.resource_subtype,current_status_update.title,due_on,followers,followers.name,html_notes,is_workspace_level,liked,likes,likes.user,likes.user.name,metric,metric.can_manage,metric.currency_code,metric.current_display_value,metric.current_number_value,metric.initial_number_value,metric.precision,metric.progress_source,metric.resource_subtype,metric.target_number_value,metric.unit,name,notes,num_likes,owner,owner.name,start_on,status,team,team.name,time_period,time_period.display_name,time_period.end_on,time_period.period,time_period.start_on,workspace,workspace.name\"\ \n};\ngoalsApiInstance.createGoalMetric(body, goal_gid, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.createGoalMetric(goalGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class goals_api_instance = asana.GoalsApi(api_client) body = {"data": {"": "", "": "",}} # dict | The goal metric to create. goal_gid = "12345" # str | Globally unique identifier for the goal. opts = { 'opt_fields': "current_status_update,current_status_update.resource_subtype,current_status_update.title,due_on,followers,followers.name,html_notes,is_workspace_level,liked,likes,likes.user,likes.user.name,metric,metric.can_manage,metric.currency_code,metric.current_display_value,metric.current_number_value,metric.initial_number_value,metric.precision,metric.progress_source,metric.resource_subtype,metric.target_number_value,metric.unit,name,notes,num_likes,owner,owner.name,start_on,status,team,team.name,time_period,time_period.display_name,time_period.end_on,time_period.period,time_period.start_on,workspace,workspace.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Create a goal metric api_response = goals_api_instance.create_goal_metric(body, goal_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling GoalsApi->create_goal_metric: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.create_goal_metric(goal_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- goals->createGoalMetric($goal_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.create_goal_metric(goal_gid: 'goal_gid', field: "value", field: "value", options: {pretty: true}) /goals/{goalGid}/setMetricCurrentValue: post: tags: - Goals summary: Update a goal metric description: |- Updates a goal's existing metric's `current_number_value` if one exists, otherwise responds with a 400 status code. Returns the complete updated goal metric record. operationId: updateGoalMetric parameters: - name: goalGid in: path description: Globally unique identifier for the goal. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: goal - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name example: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name x-ballerina-name: optFields requestBody: description: The updated fields for the goal metric. content: application/json: schema: $ref: '#/components/schemas/GoalGidSetMetricCurrentValueBody' required: true responses: "200": description: Successfully updated the goal metric. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20010' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "402": description: "The request was valid, but the queried object or object mutation\ \ specified in the request is above your current premium level." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goals.updateGoalMetric(goalGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet goalsApiInstance = new Asana.GoalsApi();\nlet body = {\"data\":\ \ {\"\": \"\", \"\": \"\",}}; // Object\ \ | The updated fields for the goal metric.\nlet goal_gid = \"12345\"\ ; // String | Globally unique identifier for the goal.\nlet opts = { \n\ \ 'opt_fields': \"current_status_update,current_status_update.resource_subtype,current_status_update.title,due_on,followers,followers.name,html_notes,is_workspace_level,liked,likes,likes.user,likes.user.name,metric,metric.can_manage,metric.currency_code,metric.current_display_value,metric.current_number_value,metric.initial_number_value,metric.precision,metric.progress_source,metric.resource_subtype,metric.target_number_value,metric.unit,name,notes,num_likes,owner,owner.name,start_on,status,team,team.name,time_period,time_period.display_name,time_period.end_on,time_period.period,time_period.start_on,workspace,workspace.name\"\ \n};\ngoalsApiInstance.updateGoalMetric(body, goal_gid, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.updateGoalMetric(goalGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class goals_api_instance = asana.GoalsApi(api_client) body = {"data": {"": "", "": "",}} # dict | The updated fields for the goal metric. goal_gid = "12345" # str | Globally unique identifier for the goal. opts = { 'opt_fields': "current_status_update,current_status_update.resource_subtype,current_status_update.title,due_on,followers,followers.name,html_notes,is_workspace_level,liked,likes,likes.user,likes.user.name,metric,metric.can_manage,metric.currency_code,metric.current_display_value,metric.current_number_value,metric.initial_number_value,metric.precision,metric.progress_source,metric.resource_subtype,metric.target_number_value,metric.unit,name,notes,num_likes,owner,owner.name,start_on,status,team,team.name,time_period,time_period.display_name,time_period.end_on,time_period.period,time_period.start_on,workspace,workspace.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Update a goal metric api_response = goals_api_instance.update_goal_metric(body, goal_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling GoalsApi->update_goal_metric: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.update_goal_metric(goal_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- goals->updateGoalMetric($goal_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.update_goal_metric(goal_gid: 'goal_gid', field: "value", field: "value", options: {pretty: true}) /goals/{goalGid}/addFollowers: post: tags: - Goals summary: Add a collaborator to a goal description: |- Adds followers to a goal. Returns the goal the followers were added to. Each goal can be associated with zero or more followers in the system. Requests to add/remove followers, if successful, will return the complete updated goal record, described above. operationId: addFollowers parameters: - name: goalGid in: path description: Globally unique identifier for the goal. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: goal - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name example: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name x-ballerina-name: optFields requestBody: description: The followers to be added as collaborators content: application/json: schema: $ref: '#/components/schemas/GoalGidAddFollowersBody' required: true responses: "200": description: Successfully added users as collaborators. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20010' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "402": description: "The request was valid, but the queried object or object mutation\ \ specified in the request is above your current premium level." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goals.addFollowers(goalGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet goalsApiInstance = new Asana.GoalsApi();\nlet body = {\"data\":\ \ {\"\": \"\", \"\": \"\",}}; // Object\ \ | The followers to be added as collaborators\nlet goal_gid = \"12345\"\ ; // String | Globally unique identifier for the goal.\nlet opts = { \n\ \ 'opt_fields': \"current_status_update,current_status_update.resource_subtype,current_status_update.title,due_on,followers,followers.name,html_notes,is_workspace_level,liked,likes,likes.user,likes.user.name,metric,metric.can_manage,metric.currency_code,metric.current_display_value,metric.current_number_value,metric.initial_number_value,metric.precision,metric.progress_source,metric.resource_subtype,metric.target_number_value,metric.unit,name,notes,num_likes,owner,owner.name,start_on,status,team,team.name,time_period,time_period.display_name,time_period.end_on,time_period.period,time_period.start_on,workspace,workspace.name\"\ \n};\ngoalsApiInstance.addFollowers(body, goal_gid, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.addFollowers(goalGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class goals_api_instance = asana.GoalsApi(api_client) body = {"data": {"": "", "": "",}} # dict | The followers to be added as collaborators goal_gid = "12345" # str | Globally unique identifier for the goal. opts = { 'opt_fields': "current_status_update,current_status_update.resource_subtype,current_status_update.title,due_on,followers,followers.name,html_notes,is_workspace_level,liked,likes,likes.user,likes.user.name,metric,metric.can_manage,metric.currency_code,metric.current_display_value,metric.current_number_value,metric.initial_number_value,metric.precision,metric.progress_source,metric.resource_subtype,metric.target_number_value,metric.unit,name,notes,num_likes,owner,owner.name,start_on,status,team,team.name,time_period,time_period.display_name,time_period.end_on,time_period.period,time_period.start_on,workspace,workspace.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Add a collaborator to a goal api_response = goals_api_instance.add_followers(body, goal_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling GoalsApi->add_followers: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.add_followers(goal_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- goals->addFollowers($goal_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.add_followers(goal_gid: 'goal_gid', field: "value", field: "value", options: {pretty: true}) /goals/{goalGid}/removeFollowers: post: tags: - Goals summary: Remove a collaborator from a goal description: |- Removes followers from a goal. Returns the goal the followers were removed from. Each goal can be associated with zero or more followers in the system. Requests to add/remove followers, if successful, will return the complete updated goal record, described above. operationId: removeFollowers parameters: - name: goalGid in: path description: Globally unique identifier for the goal. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: goal - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name example: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name x-ballerina-name: optFields requestBody: description: The followers to be removed as collaborators content: application/json: schema: $ref: '#/components/schemas/GoalGidRemoveFollowersBody' required: true responses: "200": description: Successfully removed users as collaborators. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20010' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "402": description: "The request was valid, but the queried object or object mutation\ \ specified in the request is above your current premium level." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.goals.removeFollowers(goalGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet goalsApiInstance = new Asana.GoalsApi();\nlet body = {\"data\":\ \ {\"\": \"\", \"\": \"\",}}; // Object\ \ | The followers to be removed as collaborators\nlet goal_gid = \"12345\"\ ; // String | Globally unique identifier for the goal.\nlet opts = { \n\ \ 'opt_fields': \"current_status_update,current_status_update.resource_subtype,current_status_update.title,due_on,followers,followers.name,html_notes,is_workspace_level,liked,likes,likes.user,likes.user.name,metric,metric.can_manage,metric.currency_code,metric.current_display_value,metric.current_number_value,metric.initial_number_value,metric.precision,metric.progress_source,metric.resource_subtype,metric.target_number_value,metric.unit,name,notes,num_likes,owner,owner.name,start_on,status,team,team.name,time_period,time_period.display_name,time_period.end_on,time_period.period,time_period.start_on,workspace,workspace.name\"\ \n};\ngoalsApiInstance.removeFollowers(body, goal_gid, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.removeFollowers(goalGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class goals_api_instance = asana.GoalsApi(api_client) body = {"data": {"": "", "": "",}} # dict | The followers to be removed as collaborators goal_gid = "12345" # str | Globally unique identifier for the goal. opts = { 'opt_fields': "current_status_update,current_status_update.resource_subtype,current_status_update.title,due_on,followers,followers.name,html_notes,is_workspace_level,liked,likes,likes.user,likes.user.name,metric,metric.can_manage,metric.currency_code,metric.current_display_value,metric.current_number_value,metric.initial_number_value,metric.precision,metric.progress_source,metric.resource_subtype,metric.target_number_value,metric.unit,name,notes,num_likes,owner,owner.name,start_on,status,team,team.name,time_period,time_period.display_name,time_period.end_on,time_period.period,time_period.start_on,workspace,workspace.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Remove a collaborator from a goal api_response = goals_api_instance.remove_followers(body, goal_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling GoalsApi->remove_followers: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.remove_followers(goal_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- goals->removeFollowers($goal_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.remove_followers(goal_gid: 'goal_gid', field: "value", field: "value", options: {pretty: true}) /goals/{goalGid}/parentGoals: get: tags: - Goals summary: Get parent goals from a goal description: Returns a compact representation of all of the parent goals of a goal. operationId: getParentGoalsForGoal parameters: - name: goalGid in: path description: Globally unique identifier for the goal. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: goal - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name example: - current_status_update - current_status_update.resource_subtype - current_status_update.title - due_on - followers - followers.name - html_notes - is_workspace_level - liked - likes - likes.user - likes.user.name - metric - metric.can_manage - metric.currency_code - metric.current_display_value - metric.current_number_value - metric.initial_number_value - metric.precision - metric.progress_source - metric.resource_subtype - metric.target_number_value - metric.unit - name - notes - num_likes - owner - owner.name - start_on - status - team - team.name - time_period - time_period.display_name - time_period.end_on - time_period.period - time_period.start_on - workspace - workspace.name x-ballerina-name: optFields responses: "200": description: Successfully retrieved the specified goal's parent goals. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20012' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "402": description: "The request was valid, but the queried object or object mutation\ \ specified in the request is above your current premium level." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.goals.getParentGoalsForGoal(goalGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet goalsApiInstance = new Asana.GoalsApi();\nlet goal_gid = \"12345\"\ ; // String | Globally unique identifier for the goal.\nlet opts = { \n\ \ 'opt_fields': \"current_status_update,current_status_update.resource_subtype,current_status_update.title,due_on,followers,followers.name,html_notes,is_workspace_level,liked,likes,likes.user,likes.user.name,metric,metric.can_manage,metric.currency_code,metric.current_display_value,metric.current_number_value,metric.initial_number_value,metric.precision,metric.progress_source,metric.resource_subtype,metric.target_number_value,metric.unit,name,notes,num_likes,owner,owner.name,start_on,status,team,team.name,time_period,time_period.display_name,time_period.end_on,time_period.period,time_period.start_on,workspace,workspace.name\"\ \n};\ngoalsApiInstance.getParentGoalsForGoal(goal_gid, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.goals.getParentGoalsForGoal(goalGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class goals_api_instance = asana.GoalsApi(api_client) goal_gid = "12345" # str | Globally unique identifier for the goal. opts = { 'opt_fields': "current_status_update,current_status_update.resource_subtype,current_status_update.title,due_on,followers,followers.name,html_notes,is_workspace_level,liked,likes,likes.user,likes.user.name,metric,metric.can_manage,metric.currency_code,metric.current_display_value,metric.current_number_value,metric.initial_number_value,metric.precision,metric.progress_source,metric.resource_subtype,metric.target_number_value,metric.unit,name,notes,num_likes,owner,owner.name,start_on,status,team,team.name,time_period,time_period.display_name,time_period.end_on,time_period.period,time_period.start_on,workspace,workspace.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get parent goals from a goal api_response = goals_api_instance.get_parent_goals_for_goal(goal_gid, opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling GoalsApi->get_parent_goals_for_goal: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.goals.get_parent_goals_for_goal(goal_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- goals->getParentGoalsForGoal($goal_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.goals.get_parent_goals_for_goal(goal_gid: 'goal_gid', param: "value", param: "value", options: {pretty: true}) /jobs/{jobGid}: get: tags: - Jobs summary: Get a job by id description: Returns the full record for a job. operationId: getJob parameters: - name: jobGid in: path description: Globally unique identifier for the job. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: job - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - new_project - new_project.name - new_project_template - new_project_template.name - new_task - new_task.created_by - new_task.name - new_task.resource_subtype - new_task_template - new_task_template.name - resource_subtype - status example: - new_project - new_project.name - new_project_template - new_project_template.name - new_task - new_task.created_by - new_task.name - new_task.resource_subtype - new_task_template - new_task_template.name - resource_subtype - status x-ballerina-name: optFields responses: "200": description: Successfully retrieved Job. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20013' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Job result = client.jobs.getJob(jobGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet jobsApiInstance = new Asana.JobsApi();\nlet job_gid = \"12345\"\ ; // String | Globally unique identifier for the job.\nlet opts = { \n\ \ 'opt_fields': \"new_project,new_project.name,new_project_template,new_project_template.name,new_task,new_task.created_by,new_task.name,new_task.resource_subtype,resource_subtype,status\"\ \n};\njobsApiInstance.getJob(job_gid, opts).then((result) => {\n console.log('API\ \ called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.jobs.getJob(jobGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class jobs_api_instance = asana.JobsApi(api_client) job_gid = "12345" # str | Globally unique identifier for the job. opts = { 'opt_fields': "new_project,new_project.name,new_project_template,new_project_template.name,new_task,new_task.created_by,new_task.name,new_task.resource_subtype,resource_subtype,status", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get a job by id api_response = jobs_api_instance.get_job(job_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling JobsApi->get_job: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.jobs.get_job(job_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- jobs->getJob($job_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.jobs.get_job(job_gid: 'job_gid', param: "value", param: "value", options: {pretty: true}) /memberships: get: tags: - Memberships summary: Get multiple memberships description: Returns compact `goal_membership` or `project_membership` records. The possible types for `parent` in this request are `goal` or `project`. An additional member (user GID or team GID) can be passed in to filter to a specific membership. operationId: getMemberships parameters: - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: parent in: query description: Globally unique identifier for `goal` or `project`. required: false style: form explode: true schema: type: string example: "159874" - name: member in: query description: Globally unique identifier for `team` or `user`. required: false style: form explode: true schema: type: string example: "1061493" - name: limit in: query description: |- Results per page. The number of objects to return per page. The value must be between 1 and 100. required: false style: form explode: true schema: maximum: 100 minimum: 1 type: integer example: 50 - name: offset in: query description: |- Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' required: false style: form explode: true schema: type: string example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - offset - path - uri example: - offset - path - uri x-ballerina-name: optFields responses: "200": description: Successfully retrieved the requested membership. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20014' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet membershipsApiInstance = new Asana.MembershipsApi();\nlet opts =\ \ { \n 'parent': \"159874\", \n 'member': \"1061493\", \n 'limit':\ \ 50, \n 'offset': \"eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9\", \n \ \ 'opt_fields': \"offset,path,uri\"\n};\nmembershipsApiInstance.getMemberships(opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class memberships_api_instance = asana.MembershipsApi(api_client) opts = { 'parent': "159874", # str | Globally unique identifier for `goal` or `project`. 'member': "1061493", # str | Globally unique identifier for `team` or `user`. 'limit': 50, # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': "offset,path,uri", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get multiple memberships api_response = memberships_api_instance.get_memberships(opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling MembershipsApi->get_memberships: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.memberships.get_memberships({'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- memberships->getMemberships(array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.memberships.get_memberships(parent: ''parent_example'', param: "value", param: "value", options: {pretty: true}) post: tags: - Memberships summary: Create a membership description: |- Creates a new membership in a `goal` or `project`. `Teams` or `users` can be a member of `goals` or `projects`. Returns the full record of the newly created membership. operationId: createMembership parameters: - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty requestBody: description: The updated fields for the membership. content: application/json: schema: $ref: '#/components/schemas/MembershipsBody' required: false responses: "201": description: Successfully created the requested membership. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2012' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet membershipsApiInstance = new Asana.MembershipsApi();\nlet opts =\ \ { \n 'body': {\"data\": {\"\": \"\", \"\"\ : \"\",}}\n};\nmembershipsApiInstance.createMembership(opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class memberships_api_instance = asana.MembershipsApi(api_client) opts = { 'body': {"data": {"": "", "": "",}}, # dict | The updated fields for the membership. } try: # Create a membership api_response = memberships_api_instance.create_membership(opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling MembershipsApi->create_membership: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.memberships.create_membership({'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- memberships->createMembership(array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.memberships.create_membership(field: "value", field: "value", options: {pretty: true}) /memberships/{membershipGid}: get: tags: - Memberships summary: Get a membership description: Returns compact `project_membership` record for a single membership. `GET` only supports project memberships currently operationId: getMembership parameters: - name: membershipGid in: path description: Globally unique identifier for the membership. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: membership - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - access_level - member - member.name - parent - parent.name - resource_subtype example: - access_level - member - member.name - parent - parent.name - resource_subtype x-ballerina-name: optFields responses: "200": description: Successfully retrieved the record for a single membership. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20015' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet membershipsApiInstance = new Asana.MembershipsApi();\nlet membership_gid\ \ = \"12345\"; // String | Globally unique identifier for the membership.\n\ let opts = { \n 'opt_fields': \"access_level,member,member.name,parent,parent.name,resource_subtype\"\ \n};\nmembershipsApiInstance.getMembership(membership_gid, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class memberships_api_instance = asana.MembershipsApi(api_client) membership_gid = "12345" # str | Globally unique identifier for the membership. opts = { 'opt_fields': "access_level,member,member.name,parent,parent.name,resource_subtype", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get a membership api_response = memberships_api_instance.get_membership(membership_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling MembershipsApi->get_membership: %s\n" % e) name: python-sdk-v5 put: tags: - Memberships summary: Update a membership description: |- An existing membership can be updated by making a `PUT` request on the URL for that goal. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Memberships on `goals` and `projects` can be updated. Returns the full record of the updated membership. operationId: updateMembership parameters: - name: membershipGid in: path description: Globally unique identifier for the membership. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: membership - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty requestBody: description: The membership to update. content: application/json: schema: $ref: '#/components/schemas/MembershipsmembershipGidBody' required: true responses: "200": description: Successfully updated the requested membership. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2012' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.memberships.update_membership(membership_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- memberships->updateMembership($membership_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.memberships.update_membership(membership_gid: 'membership_gid', field: "value", field: "value", options: {pretty: true}) delete: tags: - Memberships summary: Delete a membership description: |- A specific, existing membership for a `goal` or `project` can be deleted by making a `DELETE` request on the URL for that membership. Returns an empty data record. operationId: deleteMembership parameters: - name: membershipGid in: path description: Globally unique identifier for the membership. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: membership - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty responses: "200": description: Successfully deleted the requested membership. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2001' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: node install: npm install asana code: |- const Asana = require('asana'); let client = Asana.ApiClient.instance; let token = client.authentications['token']; token.accessToken = ''; let membershipsApiInstance = new Asana.MembershipsApi(); let membership_gid = "12345"; // String | Globally unique identifier for the membership. membershipsApiInstance.deleteMembership(membership_gid).then((result) => { console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2)); }, (error) => { console.error(error.response.body); }); name: node-sdk-v3 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class memberships_api_instance = asana.MembershipsApi(api_client) membership_gid = "12345" # str | Globally unique identifier for the membership. try: # Delete a membership api_response = memberships_api_instance.delete_membership(membership_gid) pprint(api_response) except ApiException as e: print("Exception when calling MembershipsApi->delete_membership: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.memberships.delete_membership(membership_gid, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- memberships->deleteMembership($membership_gid, array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.memberships.delete_membership(membership_gid: 'membership_gid', options: {pretty: true}) /organization_exports: post: tags: - Organization exports summary: Create an organization export request description: This method creates a request to export an Organization. Asana will complete the export at some point after you create the request. operationId: createOrganizationExport parameters: - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - created_at - download_url - organization - organization.name - state example: - created_at - download_url - organization - organization.name - state x-ballerina-name: optFields requestBody: description: The organization to export. content: application/json: schema: $ref: '#/components/schemas/OrganizationExportsBody' required: true responses: "201": description: Successfully created organization export request. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2013' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); OrganizationExport result = client.organizationexports.createOrganizationExport() .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet organizationExportsApiInstance = new Asana.OrganizationExportsApi();\n\ let body = {\"data\": {\"\": \"\", \"\": \"\ \",}}; // Object | The organization to export.\nlet opts = {\ \ \n 'opt_fields': \"created_at,download_url,organization,organization.name,state\"\ \n};\norganizationExportsApiInstance.createOrganizationExport(body, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.organizationexports.createOrganizationExport({field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class organization_exports_api_instance = asana.OrganizationExportsApi(api_client) body = {"data": {"": "", "": "",}} # dict | The organization to export. opts = { 'opt_fields': "created_at,download_url,organization,organization.name,state", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Create an organization export request api_response = organization_exports_api_instance.create_organization_export(body, opts) pprint(api_response) except ApiException as e: print("Exception when calling OrganizationExportsApi->create_organization_export: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.organization_exports.create_organization_export({'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- organizationexports->createOrganizationExport(array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.organization_exports.create_organization_export(field: "value", field: "value", options: {pretty: true}) /organization_exports/{organizationExportGid}: get: tags: - Organization exports summary: Get details on an org export request description: Returns details of a previously-requested Organization export. operationId: getOrganizationExport parameters: - name: organizationExportGid in: path description: Globally unique identifier for the organization export. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: organization_export - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - created_at - download_url - organization - organization.name - state example: - created_at - download_url - organization - organization.name - state x-ballerina-name: optFields responses: "200": description: Successfully retrieved organization export object. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2013' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); OrganizationExport result = client.organizationexports.getOrganizationExport(organizationExportGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet organizationExportsApiInstance = new Asana.OrganizationExportsApi();\n\ let organization_export_gid = \"12345\"; // String | Globally unique identifier\ \ for the organization export.\nlet opts = { \n 'opt_fields': \"created_at,download_url,organization,organization.name,state\"\ \n};\norganizationExportsApiInstance.getOrganizationExport(organization_export_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.organizationexports.getOrganizationExport(organizationExportGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class organization_exports_api_instance = asana.OrganizationExportsApi(api_client) organization_export_gid = "12345" # str | Globally unique identifier for the organization export. opts = { 'opt_fields': "created_at,download_url,organization,organization.name,state", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get details on an org export request api_response = organization_exports_api_instance.get_organization_export(organization_export_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling OrganizationExportsApi->get_organization_export: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.organization_exports.get_organization_export(organization_export_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- organizationexports->getOrganizationExport($organization_export_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.organization_exports.get_organization_export(organization_export_gid: 'organization_export_gid', param: "value", param: "value", options: {pretty: true}) /portfolio_memberships: get: tags: - Portfolio memberships summary: Get multiple portfolio memberships description: "Returns a list of portfolio memberships in compact representation.\ \ You must specify `portfolio`, `portfolio` and `user`, or `workspace` and\ \ `user`." operationId: getPortfolioMemberships parameters: - name: portfolio in: query description: The portfolio to filter results on. required: false style: form explode: true schema: type: string example: "12345" x-env-variable: portfolio - name: workspace in: query description: The workspace to filter results on. required: false style: form explode: true schema: type: string example: "12345" x-env-variable: workspace - name: user in: query description: "A string identifying a user. This can either be the string \"\ me\", an email, or the gid of a user." required: false style: form explode: true schema: type: string example: me x-env-variable: user - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: limit in: query description: |- Results per page. The number of objects to return per page. The value must be between 1 and 100. required: false style: form explode: true schema: maximum: 100 minimum: 1 type: integer example: 50 - name: offset in: query description: |- Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' required: false style: form explode: true schema: type: string example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - offset - path - portfolio - portfolio.name - uri - user - user.name example: - offset - path - portfolio - portfolio.name - uri - user - user.name x-ballerina-name: optFields responses: "200": description: Successfully retrieved portfolio memberships. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20016' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.portfoliomemberships.getPortfolioMemberships(user, workspace, portfolio) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet portfolioMembershipsApiInstance = new Asana.PortfolioMembershipsApi();\n\ let opts = { \n 'portfolio': \"12345\", \n 'workspace': \"12345\"\ , \n 'user': \"me\", \n 'limit': 50, \n 'offset': \"eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9\"\ , \n 'opt_fields': \"offset,path,portfolio,portfolio.name,uri,user,user.name\"\ \n};\nportfolioMembershipsApiInstance.getPortfolioMemberships(opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfoliomemberships.getPortfolioMemberships({param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class portfolio_memberships_api_instance = asana.PortfolioMembershipsApi(api_client) opts = { 'portfolio': "12345", # str | The portfolio to filter results on. 'workspace': "12345", # str | The workspace to filter results on. 'user': "me", # str | A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. 'limit': 50, # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': "offset,path,portfolio,portfolio.name,uri,user,user.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get multiple portfolio memberships api_response = portfolio_memberships_api_instance.get_portfolio_memberships(opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling PortfolioMembershipsApi->get_portfolio_memberships: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolio_memberships.get_portfolio_memberships({'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- portfoliomemberships->getPortfolioMemberships(array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolio_memberships.get_portfolio_memberships(param: "value", param: "value", options: {pretty: true}) /portfolio_memberships/{portfolioMembershipGid}: get: tags: - Portfolio memberships summary: Get a portfolio membership description: Returns the complete portfolio record for a single portfolio membership. operationId: getPortfolioMembership parameters: - name: portfolioMembershipGid in: path required: true style: simple explode: false schema: type: string example: "1331" x-env-variable: portfolio_membership - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - portfolio - portfolio.name - user - user.name example: - portfolio - portfolio.name - user - user.name x-ballerina-name: optFields responses: "200": description: Successfully retrieved the requested portfolio membership. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20017' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); PortfolioMembership result = client.portfoliomemberships.getPortfolioMembership(portfolioMembershipGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet portfolioMembershipsApiInstance = new Asana.PortfolioMembershipsApi();\n\ let portfolio_membership_gid = \"1331\"; // String | \nlet opts = { \n\ \ 'opt_fields': \"portfolio,portfolio.name,user,user.name\"\n};\nportfolioMembershipsApiInstance.getPortfolioMembership(portfolio_membership_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfoliomemberships.getPortfolioMembership(portfolioMembershipGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: "import asana\nfrom asana.rest import ApiException\nfrom pprint import\ \ pprint\n\nconfiguration = asana.Configuration()\nconfiguration.access_token\ \ = ''\napi_client = asana.ApiClient(configuration)\n\ \n# create an instance of the API class\nportfolio_memberships_api_instance\ \ = asana.PortfolioMembershipsApi(api_client)\nportfolio_membership_gid\ \ = \"1331\" # str | \nopts = {\n 'opt_fields': \"portfolio,portfolio.name,user,user.name\"\ , # list[str] | This endpoint returns a compact resource, which excludes\ \ some properties by default. To include those optional properties, set\ \ this query parameter to a comma-separated list of the properties you\ \ wish to include.\n}\n\ntry:\n # Get a portfolio membership\n api_response\ \ = portfolio_memberships_api_instance.get_portfolio_membership(portfolio_membership_gid,\ \ opts)\n pprint(api_response)\nexcept ApiException as e:\n print(\"\ Exception when calling PortfolioMembershipsApi->get_portfolio_membership:\ \ %s\\n\" % e)" name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolio_memberships.get_portfolio_membership(portfolio_membership_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- portfoliomemberships->getPortfolioMembership($portfolio_membership_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolio_memberships.get_portfolio_membership(portfolio_membership_gid: 'portfolio_membership_gid', param: "value", param: "value", options: {pretty: true}) /portfolios/{portfolioGid}/portfolio_memberships: get: tags: - Portfolio memberships summary: Get memberships from a portfolio description: Returns the compact portfolio membership records for the portfolio. operationId: getPortfolioMembershipsForPortfolio parameters: - name: portfolioGid in: path description: Globally unique identifier for the portfolio. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: portfolio - name: user in: query description: "A string identifying a user. This can either be the string \"\ me\", an email, or the gid of a user." required: false style: form explode: true schema: type: string example: me x-env-variable: user - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: limit in: query description: |- Results per page. The number of objects to return per page. The value must be between 1 and 100. required: false style: form explode: true schema: maximum: 100 minimum: 1 type: integer example: 50 - name: offset in: query description: |- Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' required: false style: form explode: true schema: type: string example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - offset - path - portfolio - portfolio.name - uri - user - user.name example: - offset - path - portfolio - portfolio.name - uri - user - user.name x-ballerina-name: optFields responses: "200": description: Successfully retrieved the requested portfolio's memberships. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20016' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.portfoliomemberships.getPortfolioMembershipsForPortfolio(portfolioGid, user) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet portfolioMembershipsApiInstance = new Asana.PortfolioMembershipsApi();\n\ let portfolio_gid = \"12345\"; // String | Globally unique identifier\ \ for the portfolio.\nlet opts = { \n 'user': \"me\", \n 'limit':\ \ 50, \n 'offset': \"eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9\", \n \ \ 'opt_fields': \"offset,path,portfolio,portfolio.name,uri,user,user.name\"\ \n};\nportfolioMembershipsApiInstance.getPortfolioMembershipsForPortfolio(portfolio_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfoliomemberships.getPortfolioMembershipsForPortfolio(portfolioGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class portfolio_memberships_api_instance = asana.PortfolioMembershipsApi(api_client) portfolio_gid = "12345" # str | Globally unique identifier for the portfolio. opts = { 'user': "me", # str | A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. 'limit': 50, # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': "offset,path,portfolio,portfolio.name,uri,user,user.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get memberships from a portfolio api_response = portfolio_memberships_api_instance.get_portfolio_memberships_for_portfolio(portfolio_gid, opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling PortfolioMembershipsApi->get_portfolio_memberships_for_portfolio: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolio_memberships.get_portfolio_memberships_for_portfolio(portfolio_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- portfoliomemberships->getPortfolioMembershipsForPortfolio($portfolio_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolio_memberships.get_portfolio_memberships_for_portfolio(portfolio_gid: 'portfolio_gid', param: "value", param: "value", options: {pretty: true}) /portfolios: get: tags: - Portfolios summary: Get multiple portfolios description: Returns a list of the portfolios in compact representation that are owned by the current API user. operationId: getPortfolios parameters: - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: limit in: query description: |- Results per page. The number of objects to return per page. The value must be between 1 and 100. required: false style: form explode: true schema: maximum: 100 minimum: 1 type: integer example: 50 - name: offset in: query description: |- Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' required: false style: form explode: true schema: type: string example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 - name: workspace in: query description: The workspace or organization to filter portfolios on. required: true style: form explode: true schema: type: string example: "1331" - name: owner in: query description: "The user who owns the portfolio. Currently, API users can only\ \ get a list of portfolios that they themselves own, unless the request\ \ is made from a Service Account. In the case of a Service Account, if this\ \ parameter is specified, then all portfolios owned by this parameter are\ \ returned. Otherwise, all portfolios across the workspace are returned." required: false style: form explode: true schema: type: string example: "14916" - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.id_prefix - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.representation_type - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.id_prefix - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.representation_type - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - offset - owner - owner.name - path - permalink_url - project_templates - project_templates.name - public - start_on - uri - workspace - workspace.name example: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.id_prefix - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.representation_type - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.id_prefix - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.representation_type - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - offset - owner - owner.name - path - permalink_url - project_templates - project_templates.name - public - start_on - uri - workspace - workspace.name x-ballerina-name: optFields responses: "200": description: Successfully retrieved portfolios. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20018' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.portfolios.getPortfolios(owner, workspace) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet portfoliosApiInstance = new Asana.PortfoliosApi();\nlet workspace\ \ = \"1331\"; // String | The workspace or organization to filter portfolios\ \ on.\nlet opts = { \n 'limit': 50, \n 'offset': \"eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9\"\ , \n 'owner': \"14916\", \n 'opt_fields': \"color,created_at,created_by,created_by.name,current_status_update,current_status_update.resource_subtype,current_status_update.title,custom_field_settings,custom_field_settings.custom_field,custom_field_settings.custom_field.asana_created_field,custom_field_settings.custom_field.created_by,custom_field_settings.custom_field.created_by.name,custom_field_settings.custom_field.currency_code,custom_field_settings.custom_field.custom_label,custom_field_settings.custom_field.custom_label_position,custom_field_settings.custom_field.date_value,custom_field_settings.custom_field.date_value.date,custom_field_settings.custom_field.date_value.date_time,custom_field_settings.custom_field.description,custom_field_settings.custom_field.display_value,custom_field_settings.custom_field.enabled,custom_field_settings.custom_field.enum_options,custom_field_settings.custom_field.enum_options.color,custom_field_settings.custom_field.enum_options.enabled,custom_field_settings.custom_field.enum_options.name,custom_field_settings.custom_field.enum_value,custom_field_settings.custom_field.enum_value.color,custom_field_settings.custom_field.enum_value.enabled,custom_field_settings.custom_field.enum_value.name,custom_field_settings.custom_field.format,custom_field_settings.custom_field.has_notifications_enabled,custom_field_settings.custom_field.is_formula_field,custom_field_settings.custom_field.is_global_to_workspace,custom_field_settings.custom_field.is_value_read_only,custom_field_settings.custom_field.multi_enum_values,custom_field_settings.custom_field.multi_enum_values.color,custom_field_settings.custom_field.multi_enum_values.enabled,custom_field_settings.custom_field.multi_enum_values.name,custom_field_settings.custom_field.name,custom_field_settings.custom_field.number_value,custom_field_settings.custom_field.people_value,custom_field_settings.custom_field.people_value.name,custom_field_settings.custom_field.precision,custom_field_settings.custom_field.resource_subtype,custom_field_settings.custom_field.text_value,custom_field_settings.custom_field.type,custom_field_settings.is_important,custom_field_settings.parent,custom_field_settings.parent.name,custom_field_settings.project,custom_field_settings.project.name,custom_fields,custom_fields.date_value,custom_fields.date_value.date,custom_fields.date_value.date_time,custom_fields.display_value,custom_fields.enabled,custom_fields.enum_options,custom_fields.enum_options.color,custom_fields.enum_options.enabled,custom_fields.enum_options.name,custom_fields.enum_value,custom_fields.enum_value.color,custom_fields.enum_value.enabled,custom_fields.enum_value.name,custom_fields.is_formula_field,custom_fields.multi_enum_values,custom_fields.multi_enum_values.color,custom_fields.multi_enum_values.enabled,custom_fields.multi_enum_values.name,custom_fields.name,custom_fields.number_value,custom_fields.resource_subtype,custom_fields.text_value,custom_fields.type,due_on,members,members.name,name,offset,owner,owner.name,path,permalink_url,project_templates,project_templates.name,public,start_on,uri,workspace,workspace.name\"\ \n};\nportfoliosApiInstance.getPortfolios(workspace, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.getPortfolios({param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class portfolios_api_instance = asana.PortfoliosApi(api_client) workspace = "1331" # str | The workspace or organization to filter portfolios on. opts = { 'limit': 50, # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'owner': "14916", # str | The user who owns the portfolio. Currently, API users can only get a list of portfolios that they themselves own, unless the request is made from a Service Account. In the case of a Service Account, if this parameter is specified, then all portfolios owned by this parameter are returned. Otherwise, all portfolios across the workspace are returned. 'opt_fields': "color,created_at,created_by,created_by.name,current_status_update,current_status_update.resource_subtype,current_status_update.title,custom_field_settings,custom_field_settings.custom_field,custom_field_settings.custom_field.asana_created_field,custom_field_settings.custom_field.created_by,custom_field_settings.custom_field.created_by.name,custom_field_settings.custom_field.currency_code,custom_field_settings.custom_field.custom_label,custom_field_settings.custom_field.custom_label_position,custom_field_settings.custom_field.date_value,custom_field_settings.custom_field.date_value.date,custom_field_settings.custom_field.date_value.date_time,custom_field_settings.custom_field.description,custom_field_settings.custom_field.display_value,custom_field_settings.custom_field.enabled,custom_field_settings.custom_field.enum_options,custom_field_settings.custom_field.enum_options.color,custom_field_settings.custom_field.enum_options.enabled,custom_field_settings.custom_field.enum_options.name,custom_field_settings.custom_field.enum_value,custom_field_settings.custom_field.enum_value.color,custom_field_settings.custom_field.enum_value.enabled,custom_field_settings.custom_field.enum_value.name,custom_field_settings.custom_field.format,custom_field_settings.custom_field.has_notifications_enabled,custom_field_settings.custom_field.id_prefix,custom_field_settings.custom_field.is_formula_field,custom_field_settings.custom_field.is_global_to_workspace,custom_field_settings.custom_field.is_value_read_only,custom_field_settings.custom_field.multi_enum_values,custom_field_settings.custom_field.multi_enum_values.color,custom_field_settings.custom_field.multi_enum_values.enabled,custom_field_settings.custom_field.multi_enum_values.name,custom_field_settings.custom_field.name,custom_field_settings.custom_field.number_value,custom_field_settings.custom_field.people_value,custom_field_settings.custom_field.people_value.name,custom_field_settings.custom_field.precision,custom_field_settings.custom_field.representation_type,custom_field_settings.custom_field.resource_subtype,custom_field_settings.custom_field.text_value,custom_field_settings.custom_field.type,custom_field_settings.is_important,custom_field_settings.parent,custom_field_settings.parent.name,custom_field_settings.project,custom_field_settings.project.name,custom_fields,custom_fields.date_value,custom_fields.date_value.date,custom_fields.date_value.date_time,custom_fields.display_value,custom_fields.enabled,custom_fields.enum_options,custom_fields.enum_options.color,custom_fields.enum_options.enabled,custom_fields.enum_options.name,custom_fields.enum_value,custom_fields.enum_value.color,custom_fields.enum_value.enabled,custom_fields.enum_value.name,custom_fields.id_prefix,custom_fields.is_formula_field,custom_fields.multi_enum_values,custom_fields.multi_enum_values.color,custom_fields.multi_enum_values.enabled,custom_fields.multi_enum_values.name,custom_fields.name,custom_fields.number_value,custom_fields.representation_type,custom_fields.resource_subtype,custom_fields.text_value,custom_fields.type,due_on,members,members.name,name,offset,owner,owner.name,path,permalink_url,project_templates,project_templates.name,public,start_on,uri,workspace,workspace.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get multiple portfolios api_response = portfolios_api_instance.get_portfolios(workspace, opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling PortfoliosApi->get_portfolios: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.get_portfolios({'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- portfolios->getPortfolios(array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.get_portfolios(workspace: ''workspace_example'', owner: ''owner_example'', param: "value", param: "value", options: {pretty: true}) post: tags: - Portfolios summary: Create a portfolio description: |- Creates a new portfolio in the given workspace with the supplied name. Note that portfolios created in the Asana UI may have some state (like the “Priority” custom field) which is automatically added to the portfolio when it is created. Portfolios created via our API will *not* be created with the same initial state to allow integrations to create their own starting state on a portfolio. operationId: createPortfolio parameters: - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.id_prefix - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.representation_type - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.id_prefix - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.representation_type - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name example: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.id_prefix - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.representation_type - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.id_prefix - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.representation_type - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name x-ballerina-name: optFields requestBody: description: The portfolio to create. content: application/json: schema: $ref: '#/components/schemas/PortfoliosBody' required: true responses: "201": description: Successfully created portfolio. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2014' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Portfolio result = client.portfolios.createPortfolio() .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet portfoliosApiInstance = new Asana.PortfoliosApi();\nlet body = {\"\ data\": {\"\": \"\", \"\": \"\",}};\ \ // Object | The portfolio to create.\nlet opts = { \n 'opt_fields':\ \ \"color,created_at,created_by,created_by.name,current_status_update,current_status_update.resource_subtype,current_status_update.title,custom_field_settings,custom_field_settings.custom_field,custom_field_settings.custom_field.asana_created_field,custom_field_settings.custom_field.created_by,custom_field_settings.custom_field.created_by.name,custom_field_settings.custom_field.currency_code,custom_field_settings.custom_field.custom_label,custom_field_settings.custom_field.custom_label_position,custom_field_settings.custom_field.date_value,custom_field_settings.custom_field.date_value.date,custom_field_settings.custom_field.date_value.date_time,custom_field_settings.custom_field.description,custom_field_settings.custom_field.display_value,custom_field_settings.custom_field.enabled,custom_field_settings.custom_field.enum_options,custom_field_settings.custom_field.enum_options.color,custom_field_settings.custom_field.enum_options.enabled,custom_field_settings.custom_field.enum_options.name,custom_field_settings.custom_field.enum_value,custom_field_settings.custom_field.enum_value.color,custom_field_settings.custom_field.enum_value.enabled,custom_field_settings.custom_field.enum_value.name,custom_field_settings.custom_field.format,custom_field_settings.custom_field.has_notifications_enabled,custom_field_settings.custom_field.is_formula_field,custom_field_settings.custom_field.is_global_to_workspace,custom_field_settings.custom_field.is_value_read_only,custom_field_settings.custom_field.multi_enum_values,custom_field_settings.custom_field.multi_enum_values.color,custom_field_settings.custom_field.multi_enum_values.enabled,custom_field_settings.custom_field.multi_enum_values.name,custom_field_settings.custom_field.name,custom_field_settings.custom_field.number_value,custom_field_settings.custom_field.people_value,custom_field_settings.custom_field.people_value.name,custom_field_settings.custom_field.precision,custom_field_settings.custom_field.resource_subtype,custom_field_settings.custom_field.text_value,custom_field_settings.custom_field.type,custom_field_settings.is_important,custom_field_settings.parent,custom_field_settings.parent.name,custom_field_settings.project,custom_field_settings.project.name,custom_fields,custom_fields.date_value,custom_fields.date_value.date,custom_fields.date_value.date_time,custom_fields.display_value,custom_fields.enabled,custom_fields.enum_options,custom_fields.enum_options.color,custom_fields.enum_options.enabled,custom_fields.enum_options.name,custom_fields.enum_value,custom_fields.enum_value.color,custom_fields.enum_value.enabled,custom_fields.enum_value.name,custom_fields.is_formula_field,custom_fields.multi_enum_values,custom_fields.multi_enum_values.color,custom_fields.multi_enum_values.enabled,custom_fields.multi_enum_values.name,custom_fields.name,custom_fields.number_value,custom_fields.resource_subtype,custom_fields.text_value,custom_fields.type,due_on,members,members.name,name,owner,owner.name,permalink_url,project_templates,project_templates.name,public,start_on,workspace,workspace.name\"\ \n};\nportfoliosApiInstance.createPortfolio(body, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.createPortfolio({field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class portfolios_api_instance = asana.PortfoliosApi(api_client) body = {"data": {"": "", "": "",}} # dict | The portfolio to create. opts = { 'opt_fields': "color,created_at,created_by,created_by.name,current_status_update,current_status_update.resource_subtype,current_status_update.title,custom_field_settings,custom_field_settings.custom_field,custom_field_settings.custom_field.asana_created_field,custom_field_settings.custom_field.created_by,custom_field_settings.custom_field.created_by.name,custom_field_settings.custom_field.currency_code,custom_field_settings.custom_field.custom_label,custom_field_settings.custom_field.custom_label_position,custom_field_settings.custom_field.date_value,custom_field_settings.custom_field.date_value.date,custom_field_settings.custom_field.date_value.date_time,custom_field_settings.custom_field.description,custom_field_settings.custom_field.display_value,custom_field_settings.custom_field.enabled,custom_field_settings.custom_field.enum_options,custom_field_settings.custom_field.enum_options.color,custom_field_settings.custom_field.enum_options.enabled,custom_field_settings.custom_field.enum_options.name,custom_field_settings.custom_field.enum_value,custom_field_settings.custom_field.enum_value.color,custom_field_settings.custom_field.enum_value.enabled,custom_field_settings.custom_field.enum_value.name,custom_field_settings.custom_field.format,custom_field_settings.custom_field.has_notifications_enabled,custom_field_settings.custom_field.id_prefix,custom_field_settings.custom_field.is_formula_field,custom_field_settings.custom_field.is_global_to_workspace,custom_field_settings.custom_field.is_value_read_only,custom_field_settings.custom_field.multi_enum_values,custom_field_settings.custom_field.multi_enum_values.color,custom_field_settings.custom_field.multi_enum_values.enabled,custom_field_settings.custom_field.multi_enum_values.name,custom_field_settings.custom_field.name,custom_field_settings.custom_field.number_value,custom_field_settings.custom_field.people_value,custom_field_settings.custom_field.people_value.name,custom_field_settings.custom_field.precision,custom_field_settings.custom_field.representation_type,custom_field_settings.custom_field.resource_subtype,custom_field_settings.custom_field.text_value,custom_field_settings.custom_field.type,custom_field_settings.is_important,custom_field_settings.parent,custom_field_settings.parent.name,custom_field_settings.project,custom_field_settings.project.name,custom_fields,custom_fields.date_value,custom_fields.date_value.date,custom_fields.date_value.date_time,custom_fields.display_value,custom_fields.enabled,custom_fields.enum_options,custom_fields.enum_options.color,custom_fields.enum_options.enabled,custom_fields.enum_options.name,custom_fields.enum_value,custom_fields.enum_value.color,custom_fields.enum_value.enabled,custom_fields.enum_value.name,custom_fields.id_prefix,custom_fields.is_formula_field,custom_fields.multi_enum_values,custom_fields.multi_enum_values.color,custom_fields.multi_enum_values.enabled,custom_fields.multi_enum_values.name,custom_fields.name,custom_fields.number_value,custom_fields.representation_type,custom_fields.resource_subtype,custom_fields.text_value,custom_fields.type,due_on,members,members.name,name,owner,owner.name,permalink_url,project_templates,project_templates.name,public,start_on,workspace,workspace.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Create a portfolio api_response = portfolios_api_instance.create_portfolio(body, opts) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->create_portfolio: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.create_portfolio({'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- portfolios->createPortfolio(array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.create_portfolio(field: "value", field: "value", options: {pretty: true}) /portfolios/{portfolioGid}: get: tags: - Portfolios summary: Get a portfolio description: Returns the complete portfolio record for a single portfolio. operationId: getPortfolio parameters: - name: portfolioGid in: path description: Globally unique identifier for the portfolio. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: portfolio - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.id_prefix - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.representation_type - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.id_prefix - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.representation_type - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name example: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.id_prefix - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.representation_type - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.id_prefix - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.representation_type - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name x-ballerina-name: optFields responses: "200": description: Successfully retrieved the requested portfolio. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2014' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Portfolio result = client.portfolios.getPortfolio(portfolioGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet portfoliosApiInstance = new Asana.PortfoliosApi();\nlet portfolio_gid\ \ = \"12345\"; // String | Globally unique identifier for the portfolio.\n\ let opts = { \n 'opt_fields': \"color,created_at,created_by,created_by.name,current_status_update,current_status_update.resource_subtype,current_status_update.title,custom_field_settings,custom_field_settings.custom_field,custom_field_settings.custom_field.asana_created_field,custom_field_settings.custom_field.created_by,custom_field_settings.custom_field.created_by.name,custom_field_settings.custom_field.currency_code,custom_field_settings.custom_field.custom_label,custom_field_settings.custom_field.custom_label_position,custom_field_settings.custom_field.date_value,custom_field_settings.custom_field.date_value.date,custom_field_settings.custom_field.date_value.date_time,custom_field_settings.custom_field.description,custom_field_settings.custom_field.display_value,custom_field_settings.custom_field.enabled,custom_field_settings.custom_field.enum_options,custom_field_settings.custom_field.enum_options.color,custom_field_settings.custom_field.enum_options.enabled,custom_field_settings.custom_field.enum_options.name,custom_field_settings.custom_field.enum_value,custom_field_settings.custom_field.enum_value.color,custom_field_settings.custom_field.enum_value.enabled,custom_field_settings.custom_field.enum_value.name,custom_field_settings.custom_field.format,custom_field_settings.custom_field.has_notifications_enabled,custom_field_settings.custom_field.is_formula_field,custom_field_settings.custom_field.is_global_to_workspace,custom_field_settings.custom_field.is_value_read_only,custom_field_settings.custom_field.multi_enum_values,custom_field_settings.custom_field.multi_enum_values.color,custom_field_settings.custom_field.multi_enum_values.enabled,custom_field_settings.custom_field.multi_enum_values.name,custom_field_settings.custom_field.name,custom_field_settings.custom_field.number_value,custom_field_settings.custom_field.people_value,custom_field_settings.custom_field.people_value.name,custom_field_settings.custom_field.precision,custom_field_settings.custom_field.resource_subtype,custom_field_settings.custom_field.text_value,custom_field_settings.custom_field.type,custom_field_settings.is_important,custom_field_settings.parent,custom_field_settings.parent.name,custom_field_settings.project,custom_field_settings.project.name,custom_fields,custom_fields.date_value,custom_fields.date_value.date,custom_fields.date_value.date_time,custom_fields.display_value,custom_fields.enabled,custom_fields.enum_options,custom_fields.enum_options.color,custom_fields.enum_options.enabled,custom_fields.enum_options.name,custom_fields.enum_value,custom_fields.enum_value.color,custom_fields.enum_value.enabled,custom_fields.enum_value.name,custom_fields.is_formula_field,custom_fields.multi_enum_values,custom_fields.multi_enum_values.color,custom_fields.multi_enum_values.enabled,custom_fields.multi_enum_values.name,custom_fields.name,custom_fields.number_value,custom_fields.resource_subtype,custom_fields.text_value,custom_fields.type,due_on,members,members.name,name,owner,owner.name,permalink_url,project_templates,project_templates.name,public,start_on,workspace,workspace.name\"\ \n};\nportfoliosApiInstance.getPortfolio(portfolio_gid, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.getPortfolio(portfolioGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class portfolios_api_instance = asana.PortfoliosApi(api_client) portfolio_gid = "12345" # str | Globally unique identifier for the portfolio. opts = { 'opt_fields': "color,created_at,created_by,created_by.name,current_status_update,current_status_update.resource_subtype,current_status_update.title,custom_field_settings,custom_field_settings.custom_field,custom_field_settings.custom_field.asana_created_field,custom_field_settings.custom_field.created_by,custom_field_settings.custom_field.created_by.name,custom_field_settings.custom_field.currency_code,custom_field_settings.custom_field.custom_label,custom_field_settings.custom_field.custom_label_position,custom_field_settings.custom_field.date_value,custom_field_settings.custom_field.date_value.date,custom_field_settings.custom_field.date_value.date_time,custom_field_settings.custom_field.description,custom_field_settings.custom_field.display_value,custom_field_settings.custom_field.enabled,custom_field_settings.custom_field.enum_options,custom_field_settings.custom_field.enum_options.color,custom_field_settings.custom_field.enum_options.enabled,custom_field_settings.custom_field.enum_options.name,custom_field_settings.custom_field.enum_value,custom_field_settings.custom_field.enum_value.color,custom_field_settings.custom_field.enum_value.enabled,custom_field_settings.custom_field.enum_value.name,custom_field_settings.custom_field.format,custom_field_settings.custom_field.has_notifications_enabled,custom_field_settings.custom_field.id_prefix,custom_field_settings.custom_field.is_formula_field,custom_field_settings.custom_field.is_global_to_workspace,custom_field_settings.custom_field.is_value_read_only,custom_field_settings.custom_field.multi_enum_values,custom_field_settings.custom_field.multi_enum_values.color,custom_field_settings.custom_field.multi_enum_values.enabled,custom_field_settings.custom_field.multi_enum_values.name,custom_field_settings.custom_field.name,custom_field_settings.custom_field.number_value,custom_field_settings.custom_field.people_value,custom_field_settings.custom_field.people_value.name,custom_field_settings.custom_field.precision,custom_field_settings.custom_field.representation_type,custom_field_settings.custom_field.resource_subtype,custom_field_settings.custom_field.text_value,custom_field_settings.custom_field.type,custom_field_settings.is_important,custom_field_settings.parent,custom_field_settings.parent.name,custom_field_settings.project,custom_field_settings.project.name,custom_fields,custom_fields.date_value,custom_fields.date_value.date,custom_fields.date_value.date_time,custom_fields.display_value,custom_fields.enabled,custom_fields.enum_options,custom_fields.enum_options.color,custom_fields.enum_options.enabled,custom_fields.enum_options.name,custom_fields.enum_value,custom_fields.enum_value.color,custom_fields.enum_value.enabled,custom_fields.enum_value.name,custom_fields.id_prefix,custom_fields.is_formula_field,custom_fields.multi_enum_values,custom_fields.multi_enum_values.color,custom_fields.multi_enum_values.enabled,custom_fields.multi_enum_values.name,custom_fields.name,custom_fields.number_value,custom_fields.representation_type,custom_fields.resource_subtype,custom_fields.text_value,custom_fields.type,due_on,members,members.name,name,owner,owner.name,permalink_url,project_templates,project_templates.name,public,start_on,workspace,workspace.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get a portfolio api_response = portfolios_api_instance.get_portfolio(portfolio_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->get_portfolio: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.get_portfolio(portfolio_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- portfolios->getPortfolio($portfolio_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.get_portfolio(portfolio_gid: 'portfolio_gid', param: "value", param: "value", options: {pretty: true}) put: tags: - Portfolios summary: Update a portfolio description: |- An existing portfolio can be updated by making a PUT request on the URL for that portfolio. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Returns the complete updated portfolio record. operationId: updatePortfolio parameters: - name: portfolioGid in: path description: Globally unique identifier for the portfolio. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: portfolio - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.id_prefix - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.representation_type - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.id_prefix - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.representation_type - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name example: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.id_prefix - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.representation_type - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.id_prefix - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.representation_type - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name x-ballerina-name: optFields requestBody: description: The updated fields for the portfolio. content: application/json: schema: $ref: '#/components/schemas/PortfoliosportfolioGidBody' required: true responses: "200": description: Successfully updated the portfolio. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2014' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Portfolio result = client.portfolios.updatePortfolio(portfolioGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet portfoliosApiInstance = new Asana.PortfoliosApi();\nlet body = {\"\ data\": {\"\": \"\", \"\": \"\",}};\ \ // Object | The updated fields for the portfolio.\nlet portfolio_gid\ \ = \"12345\"; // String | Globally unique identifier for the portfolio.\n\ let opts = { \n 'opt_fields': \"color,created_at,created_by,created_by.name,current_status_update,current_status_update.resource_subtype,current_status_update.title,custom_field_settings,custom_field_settings.custom_field,custom_field_settings.custom_field.asana_created_field,custom_field_settings.custom_field.created_by,custom_field_settings.custom_field.created_by.name,custom_field_settings.custom_field.currency_code,custom_field_settings.custom_field.custom_label,custom_field_settings.custom_field.custom_label_position,custom_field_settings.custom_field.date_value,custom_field_settings.custom_field.date_value.date,custom_field_settings.custom_field.date_value.date_time,custom_field_settings.custom_field.description,custom_field_settings.custom_field.display_value,custom_field_settings.custom_field.enabled,custom_field_settings.custom_field.enum_options,custom_field_settings.custom_field.enum_options.color,custom_field_settings.custom_field.enum_options.enabled,custom_field_settings.custom_field.enum_options.name,custom_field_settings.custom_field.enum_value,custom_field_settings.custom_field.enum_value.color,custom_field_settings.custom_field.enum_value.enabled,custom_field_settings.custom_field.enum_value.name,custom_field_settings.custom_field.format,custom_field_settings.custom_field.has_notifications_enabled,custom_field_settings.custom_field.is_formula_field,custom_field_settings.custom_field.is_global_to_workspace,custom_field_settings.custom_field.is_value_read_only,custom_field_settings.custom_field.multi_enum_values,custom_field_settings.custom_field.multi_enum_values.color,custom_field_settings.custom_field.multi_enum_values.enabled,custom_field_settings.custom_field.multi_enum_values.name,custom_field_settings.custom_field.name,custom_field_settings.custom_field.number_value,custom_field_settings.custom_field.people_value,custom_field_settings.custom_field.people_value.name,custom_field_settings.custom_field.precision,custom_field_settings.custom_field.resource_subtype,custom_field_settings.custom_field.text_value,custom_field_settings.custom_field.type,custom_field_settings.is_important,custom_field_settings.parent,custom_field_settings.parent.name,custom_field_settings.project,custom_field_settings.project.name,custom_fields,custom_fields.date_value,custom_fields.date_value.date,custom_fields.date_value.date_time,custom_fields.display_value,custom_fields.enabled,custom_fields.enum_options,custom_fields.enum_options.color,custom_fields.enum_options.enabled,custom_fields.enum_options.name,custom_fields.enum_value,custom_fields.enum_value.color,custom_fields.enum_value.enabled,custom_fields.enum_value.name,custom_fields.is_formula_field,custom_fields.multi_enum_values,custom_fields.multi_enum_values.color,custom_fields.multi_enum_values.enabled,custom_fields.multi_enum_values.name,custom_fields.name,custom_fields.number_value,custom_fields.resource_subtype,custom_fields.text_value,custom_fields.type,due_on,members,members.name,name,owner,owner.name,permalink_url,project_templates,project_templates.name,public,start_on,workspace,workspace.name\"\ \n};\nportfoliosApiInstance.updatePortfolio(body, portfolio_gid, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.updatePortfolio(portfolioGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class portfolios_api_instance = asana.PortfoliosApi(api_client) body = {"data": {"": "", "": "",}} # dict | The updated fields for the portfolio. portfolio_gid = "12345" # str | Globally unique identifier for the portfolio. opts = { 'opt_fields': "color,created_at,created_by,created_by.name,current_status_update,current_status_update.resource_subtype,current_status_update.title,custom_field_settings,custom_field_settings.custom_field,custom_field_settings.custom_field.asana_created_field,custom_field_settings.custom_field.created_by,custom_field_settings.custom_field.created_by.name,custom_field_settings.custom_field.currency_code,custom_field_settings.custom_field.custom_label,custom_field_settings.custom_field.custom_label_position,custom_field_settings.custom_field.date_value,custom_field_settings.custom_field.date_value.date,custom_field_settings.custom_field.date_value.date_time,custom_field_settings.custom_field.description,custom_field_settings.custom_field.display_value,custom_field_settings.custom_field.enabled,custom_field_settings.custom_field.enum_options,custom_field_settings.custom_field.enum_options.color,custom_field_settings.custom_field.enum_options.enabled,custom_field_settings.custom_field.enum_options.name,custom_field_settings.custom_field.enum_value,custom_field_settings.custom_field.enum_value.color,custom_field_settings.custom_field.enum_value.enabled,custom_field_settings.custom_field.enum_value.name,custom_field_settings.custom_field.format,custom_field_settings.custom_field.has_notifications_enabled,custom_field_settings.custom_field.id_prefix,custom_field_settings.custom_field.is_formula_field,custom_field_settings.custom_field.is_global_to_workspace,custom_field_settings.custom_field.is_value_read_only,custom_field_settings.custom_field.multi_enum_values,custom_field_settings.custom_field.multi_enum_values.color,custom_field_settings.custom_field.multi_enum_values.enabled,custom_field_settings.custom_field.multi_enum_values.name,custom_field_settings.custom_field.name,custom_field_settings.custom_field.number_value,custom_field_settings.custom_field.people_value,custom_field_settings.custom_field.people_value.name,custom_field_settings.custom_field.precision,custom_field_settings.custom_field.representation_type,custom_field_settings.custom_field.resource_subtype,custom_field_settings.custom_field.text_value,custom_field_settings.custom_field.type,custom_field_settings.is_important,custom_field_settings.parent,custom_field_settings.parent.name,custom_field_settings.project,custom_field_settings.project.name,custom_fields,custom_fields.date_value,custom_fields.date_value.date,custom_fields.date_value.date_time,custom_fields.display_value,custom_fields.enabled,custom_fields.enum_options,custom_fields.enum_options.color,custom_fields.enum_options.enabled,custom_fields.enum_options.name,custom_fields.enum_value,custom_fields.enum_value.color,custom_fields.enum_value.enabled,custom_fields.enum_value.name,custom_fields.id_prefix,custom_fields.is_formula_field,custom_fields.multi_enum_values,custom_fields.multi_enum_values.color,custom_fields.multi_enum_values.enabled,custom_fields.multi_enum_values.name,custom_fields.name,custom_fields.number_value,custom_fields.representation_type,custom_fields.resource_subtype,custom_fields.text_value,custom_fields.type,due_on,members,members.name,name,owner,owner.name,permalink_url,project_templates,project_templates.name,public,start_on,workspace,workspace.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Update a portfolio api_response = portfolios_api_instance.update_portfolio(body, portfolio_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->update_portfolio: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.update_portfolio(portfolio_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- portfolios->updatePortfolio($portfolio_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.update_portfolio(portfolio_gid: 'portfolio_gid', field: "value", field: "value", options: {pretty: true}) delete: tags: - Portfolios summary: Delete a portfolio description: |- An existing portfolio can be deleted by making a DELETE request on the URL for that portfolio. Returns an empty data record. operationId: deletePortfolio parameters: - name: portfolioGid in: path description: Globally unique identifier for the portfolio. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: portfolio - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty responses: "200": description: Successfully deleted the specified portfolio. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2001' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.portfolios.deletePortfolio(portfolioGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: |- const Asana = require('asana'); let client = Asana.ApiClient.instance; let token = client.authentications['token']; token.accessToken = ''; let portfoliosApiInstance = new Asana.PortfoliosApi(); let portfolio_gid = "12345"; // String | Globally unique identifier for the portfolio. portfoliosApiInstance.deletePortfolio(portfolio_gid).then((result) => { console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2)); }, (error) => { console.error(error.response.body); }); name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.deletePortfolio(portfolioGid) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class portfolios_api_instance = asana.PortfoliosApi(api_client) portfolio_gid = "12345" # str | Globally unique identifier for the portfolio. try: # Delete a portfolio api_response = portfolios_api_instance.delete_portfolio(portfolio_gid) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->delete_portfolio: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.delete_portfolio(portfolio_gid, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- portfolios->deletePortfolio($portfolio_gid, array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.delete_portfolio(portfolio_gid: 'portfolio_gid', options: {pretty: true}) /portfolios/{portfolioGid}/items: get: tags: - Portfolios summary: Get portfolio items description: Get a list of the items in compact form in a portfolio. operationId: getItemsForPortfolio parameters: - name: portfolioGid in: path description: Globally unique identifier for the portfolio. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: portfolio - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: limit in: query description: |- Results per page. The number of objects to return per page. The value must be between 1 and 100. required: false style: form explode: true schema: maximum: 100 minimum: 1 type: integer example: 50 - name: offset in: query description: |- Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' required: false style: form explode: true schema: type: string example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - archived - color - completed - completed_at - completed_by - completed_by.name - created_at - created_from_template - created_from_template.name - current_status - current_status.author - current_status.author.name - current_status.color - current_status.created_at - current_status.created_by - current_status.created_by.name - current_status.html_text - current_status.modified_at - current_status.text - current_status.title - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.id_prefix - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.representation_type - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.id_prefix - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.representation_type - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - default_access_level - default_view - due_date - due_on - followers - followers.name - html_notes - icon - members - members.name - minimum_access_level_for_customization - minimum_access_level_for_sharing - modified_at - name - notes - offset - owner - path - permalink_url - privacy_setting - project_brief - public - start_on - team - team.name - uri - workspace - workspace.name example: - archived - color - completed - completed_at - completed_by - completed_by.name - created_at - created_from_template - created_from_template.name - current_status - current_status.author - current_status.author.name - current_status.color - current_status.created_at - current_status.created_by - current_status.created_by.name - current_status.html_text - current_status.modified_at - current_status.text - current_status.title - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.id_prefix - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.representation_type - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.id_prefix - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.representation_type - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - default_access_level - default_view - due_date - due_on - followers - followers.name - html_notes - icon - members - members.name - minimum_access_level_for_customization - minimum_access_level_for_sharing - modified_at - name - notes - offset - owner - path - permalink_url - privacy_setting - project_brief - public - start_on - team - team.name - uri - workspace - workspace.name x-ballerina-name: optFields responses: "200": description: Successfully retrieved the requested portfolio's items. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20019' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.portfolios.getItemsForPortfolio(portfolioGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet portfoliosApiInstance = new Asana.PortfoliosApi();\nlet portfolio_gid\ \ = \"12345\"; // String | Globally unique identifier for the portfolio.\n\ let opts = { \n 'limit': 50, \n 'offset': \"eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9\"\ , \n 'opt_fields': \"archived,color,completed,completed_at,completed_by,completed_by.name,created_at,created_from_template,created_from_template.name,current_status,current_status.author,current_status.author.name,current_status.color,current_status.created_at,current_status.created_by,current_status.created_by.name,current_status.html_text,current_status.modified_at,current_status.text,current_status.title,current_status_update,current_status_update.resource_subtype,current_status_update.title,custom_field_settings,custom_field_settings.custom_field,custom_field_settings.custom_field.asana_created_field,custom_field_settings.custom_field.created_by,custom_field_settings.custom_field.created_by.name,custom_field_settings.custom_field.currency_code,custom_field_settings.custom_field.custom_label,custom_field_settings.custom_field.custom_label_position,custom_field_settings.custom_field.date_value,custom_field_settings.custom_field.date_value.date,custom_field_settings.custom_field.date_value.date_time,custom_field_settings.custom_field.description,custom_field_settings.custom_field.display_value,custom_field_settings.custom_field.enabled,custom_field_settings.custom_field.enum_options,custom_field_settings.custom_field.enum_options.color,custom_field_settings.custom_field.enum_options.enabled,custom_field_settings.custom_field.enum_options.name,custom_field_settings.custom_field.enum_value,custom_field_settings.custom_field.enum_value.color,custom_field_settings.custom_field.enum_value.enabled,custom_field_settings.custom_field.enum_value.name,custom_field_settings.custom_field.format,custom_field_settings.custom_field.has_notifications_enabled,custom_field_settings.custom_field.is_formula_field,custom_field_settings.custom_field.is_global_to_workspace,custom_field_settings.custom_field.is_value_read_only,custom_field_settings.custom_field.multi_enum_values,custom_field_settings.custom_field.multi_enum_values.color,custom_field_settings.custom_field.multi_enum_values.enabled,custom_field_settings.custom_field.multi_enum_values.name,custom_field_settings.custom_field.name,custom_field_settings.custom_field.number_value,custom_field_settings.custom_field.people_value,custom_field_settings.custom_field.people_value.name,custom_field_settings.custom_field.precision,custom_field_settings.custom_field.resource_subtype,custom_field_settings.custom_field.text_value,custom_field_settings.custom_field.type,custom_field_settings.is_important,custom_field_settings.parent,custom_field_settings.parent.name,custom_field_settings.project,custom_field_settings.project.name,custom_fields,custom_fields.date_value,custom_fields.date_value.date,custom_fields.date_value.date_time,custom_fields.display_value,custom_fields.enabled,custom_fields.enum_options,custom_fields.enum_options.color,custom_fields.enum_options.enabled,custom_fields.enum_options.name,custom_fields.enum_value,custom_fields.enum_value.color,custom_fields.enum_value.enabled,custom_fields.enum_value.name,custom_fields.is_formula_field,custom_fields.multi_enum_values,custom_fields.multi_enum_values.color,custom_fields.multi_enum_values.enabled,custom_fields.multi_enum_values.name,custom_fields.name,custom_fields.number_value,custom_fields.resource_subtype,custom_fields.text_value,custom_fields.type,default_access_level,default_view,due_date,due_on,followers,followers.name,html_notes,icon,members,members.name,minimum_access_level_for_customization,minimum_access_level_for_sharing,modified_at,name,notes,offset,owner,path,permalink_url,project_brief,public,start_on,team,team.name,uri,workspace,workspace.name\"\ \n};\nportfoliosApiInstance.getItemsForPortfolio(portfolio_gid, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.getItemsForPortfolio(portfolioGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class portfolios_api_instance = asana.PortfoliosApi(api_client) portfolio_gid = "12345" # str | Globally unique identifier for the portfolio. opts = { 'limit': 50, # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': "archived,color,completed,completed_at,completed_by,completed_by.name,created_at,created_from_template,created_from_template.name,current_status,current_status.author,current_status.author.name,current_status.color,current_status.created_at,current_status.created_by,current_status.created_by.name,current_status.html_text,current_status.modified_at,current_status.text,current_status.title,current_status_update,current_status_update.resource_subtype,current_status_update.title,custom_field_settings,custom_field_settings.custom_field,custom_field_settings.custom_field.asana_created_field,custom_field_settings.custom_field.created_by,custom_field_settings.custom_field.created_by.name,custom_field_settings.custom_field.currency_code,custom_field_settings.custom_field.custom_label,custom_field_settings.custom_field.custom_label_position,custom_field_settings.custom_field.date_value,custom_field_settings.custom_field.date_value.date,custom_field_settings.custom_field.date_value.date_time,custom_field_settings.custom_field.description,custom_field_settings.custom_field.display_value,custom_field_settings.custom_field.enabled,custom_field_settings.custom_field.enum_options,custom_field_settings.custom_field.enum_options.color,custom_field_settings.custom_field.enum_options.enabled,custom_field_settings.custom_field.enum_options.name,custom_field_settings.custom_field.enum_value,custom_field_settings.custom_field.enum_value.color,custom_field_settings.custom_field.enum_value.enabled,custom_field_settings.custom_field.enum_value.name,custom_field_settings.custom_field.format,custom_field_settings.custom_field.has_notifications_enabled,custom_field_settings.custom_field.id_prefix,custom_field_settings.custom_field.is_formula_field,custom_field_settings.custom_field.is_global_to_workspace,custom_field_settings.custom_field.is_value_read_only,custom_field_settings.custom_field.multi_enum_values,custom_field_settings.custom_field.multi_enum_values.color,custom_field_settings.custom_field.multi_enum_values.enabled,custom_field_settings.custom_field.multi_enum_values.name,custom_field_settings.custom_field.name,custom_field_settings.custom_field.number_value,custom_field_settings.custom_field.people_value,custom_field_settings.custom_field.people_value.name,custom_field_settings.custom_field.precision,custom_field_settings.custom_field.representation_type,custom_field_settings.custom_field.resource_subtype,custom_field_settings.custom_field.text_value,custom_field_settings.custom_field.type,custom_field_settings.is_important,custom_field_settings.parent,custom_field_settings.parent.name,custom_field_settings.project,custom_field_settings.project.name,custom_fields,custom_fields.date_value,custom_fields.date_value.date,custom_fields.date_value.date_time,custom_fields.display_value,custom_fields.enabled,custom_fields.enum_options,custom_fields.enum_options.color,custom_fields.enum_options.enabled,custom_fields.enum_options.name,custom_fields.enum_value,custom_fields.enum_value.color,custom_fields.enum_value.enabled,custom_fields.enum_value.name,custom_fields.id_prefix,custom_fields.is_formula_field,custom_fields.multi_enum_values,custom_fields.multi_enum_values.color,custom_fields.multi_enum_values.enabled,custom_fields.multi_enum_values.name,custom_fields.name,custom_fields.number_value,custom_fields.representation_type,custom_fields.resource_subtype,custom_fields.text_value,custom_fields.type,default_access_level,default_view,due_date,due_on,followers,followers.name,html_notes,icon,members,members.name,minimum_access_level_for_customization,minimum_access_level_for_sharing,modified_at,name,notes,offset,owner,path,permalink_url,project_brief,public,start_on,team,team.name,uri,workspace,workspace.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get portfolio items api_response = portfolios_api_instance.get_items_for_portfolio(portfolio_gid, opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling PortfoliosApi->get_items_for_portfolio: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.get_items_for_portfolio(portfolio_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- portfolios->getItemsForPortfolio($portfolio_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.get_items_for_portfolio(portfolio_gid: 'portfolio_gid', param: "value", param: "value", options: {pretty: true}) /portfolios/{portfolioGid}/addItem: post: tags: - Portfolios summary: Add a portfolio item description: |- Add an item to a portfolio. Returns an empty data block. operationId: addItemForPortfolio parameters: - name: portfolioGid in: path description: Globally unique identifier for the portfolio. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: portfolio - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty requestBody: description: Information about the item being inserted. content: application/json: schema: $ref: '#/components/schemas/PortfolioGidAddItemBody' required: true responses: "200": description: Successfully added the item to the portfolio. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2001' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.portfolios.addItemForPortfolio(portfolioGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: |- const Asana = require('asana'); let client = Asana.ApiClient.instance; let token = client.authentications['token']; token.accessToken = ''; let portfoliosApiInstance = new Asana.PortfoliosApi(); let body = {"data": {"": "", "": "",}}; // Object | Information about the item being inserted. let portfolio_gid = "12345"; // String | Globally unique identifier for the portfolio. portfoliosApiInstance.addItemForPortfolio(body, portfolio_gid).then((result) => { console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2)); }, (error) => { console.error(error.response.body); }); name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.addItemForPortfolio(portfolioGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class portfolios_api_instance = asana.PortfoliosApi(api_client) body = {"data": {"": "", "": "",}} # dict | Information about the item being inserted. portfolio_gid = "12345" # str | Globally unique identifier for the portfolio. try: # Add a portfolio item api_response = portfolios_api_instance.add_item_for_portfolio(body, portfolio_gid) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->add_item_for_portfolio: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.add_item_for_portfolio(portfolio_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- portfolios->addItemForPortfolio($portfolio_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.add_item_for_portfolio(portfolio_gid: 'portfolio_gid', field: "value", field: "value", options: {pretty: true}) /portfolios/{portfolioGid}/removeItem: post: tags: - Portfolios summary: Remove a portfolio item description: |- Remove an item from a portfolio. Returns an empty data block. operationId: removeItemForPortfolio parameters: - name: portfolioGid in: path description: Globally unique identifier for the portfolio. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: portfolio - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty requestBody: description: Information about the item being removed. content: application/json: schema: $ref: '#/components/schemas/PortfolioGidRemoveItemBody' required: true responses: "200": description: Successfully removed the item from the portfolio. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2001' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.portfolios.removeItemForPortfolio(portfolioGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: |- const Asana = require('asana'); let client = Asana.ApiClient.instance; let token = client.authentications['token']; token.accessToken = ''; let portfoliosApiInstance = new Asana.PortfoliosApi(); let body = {"data": {"": "", "": "",}}; // Object | Information about the item being removed. let portfolio_gid = "12345"; // String | Globally unique identifier for the portfolio. portfoliosApiInstance.removeItemForPortfolio(body, portfolio_gid).then((result) => { console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2)); }, (error) => { console.error(error.response.body); }); name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.removeItemForPortfolio(portfolioGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class portfolios_api_instance = asana.PortfoliosApi(api_client) body = {"data": {"": "", "": "",}} # dict | Information about the item being removed. portfolio_gid = "12345" # str | Globally unique identifier for the portfolio. try: # Remove a portfolio item api_response = portfolios_api_instance.remove_item_for_portfolio(body, portfolio_gid) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->remove_item_for_portfolio: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.remove_item_for_portfolio(portfolio_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- portfolios->removeItemForPortfolio($portfolio_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.remove_item_for_portfolio(portfolio_gid: 'portfolio_gid', field: "value", field: "value", options: {pretty: true}) /portfolios/{portfolioGid}/addCustomFieldSetting: post: tags: - Portfolios summary: Add a custom field to a portfolio description: Custom fields are associated with portfolios by way of custom field settings. This method creates a setting for the portfolio. operationId: addCustomFieldSettingForPortfolio parameters: - name: portfolioGid in: path description: Globally unique identifier for the portfolio. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: portfolio - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty requestBody: description: Information about the custom field setting. content: application/json: schema: $ref: '#/components/schemas/PortfolioGidAddCustomFieldSettingBody' required: true responses: "200": description: Successfully added the custom field to the portfolio. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20020' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); CustomFieldSetting result = client.portfolios.addCustomFieldSettingForPortfolio(portfolioGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: |- const Asana = require('asana'); let client = Asana.ApiClient.instance; let token = client.authentications['token']; token.accessToken = ''; let portfoliosApiInstance = new Asana.PortfoliosApi(); let body = {"data": {"": "", "": "",}}; // Object | Information about the custom field setting. let portfolio_gid = "12345"; // String | Globally unique identifier for the portfolio. portfoliosApiInstance.addCustomFieldSettingForPortfolio(body, portfolio_gid).then((result) => { console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2)); }, (error) => { console.error(error.response.body); }); name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.addCustomFieldSettingForPortfolio(portfolioGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class portfolios_api_instance = asana.PortfoliosApi(api_client) body = {"data": {"": "", "": "",}} # dict | Information about the custom field setting. portfolio_gid = "12345" # str | Globally unique identifier for the portfolio. try: # Add a custom field to a portfolio api_response = portfolios_api_instance.add_custom_field_setting_for_portfolio(body, portfolio_gid) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->add_custom_field_setting_for_portfolio: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.add_custom_field_setting_for_portfolio(portfolio_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- portfolios->addCustomFieldSettingForPortfolio($portfolio_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.add_custom_field_setting_for_portfolio(portfolio_gid: 'portfolio_gid', field: "value", field: "value", options: {pretty: true}) /portfolios/{portfolioGid}/removeCustomFieldSetting: post: tags: - Portfolios summary: Remove a custom field from a portfolio description: Removes a custom field setting from a portfolio. operationId: removeCustomFieldSettingForPortfolio parameters: - name: portfolioGid in: path description: Globally unique identifier for the portfolio. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: portfolio - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty requestBody: description: Information about the custom field setting being removed. content: application/json: schema: $ref: '#/components/schemas/PortfolioGidRemoveCustomFieldSettingBody' required: true responses: "200": description: Successfully removed the custom field from the portfolio. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2001' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.portfolios.removeCustomFieldSettingForPortfolio(portfolioGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: |- const Asana = require('asana'); let client = Asana.ApiClient.instance; let token = client.authentications['token']; token.accessToken = ''; let portfoliosApiInstance = new Asana.PortfoliosApi(); let body = {"data": {"": "", "": "",}}; // Object | Information about the custom field setting being removed. let portfolio_gid = "12345"; // String | Globally unique identifier for the portfolio. portfoliosApiInstance.removeCustomFieldSettingForPortfolio(body, portfolio_gid).then((result) => { console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2)); }, (error) => { console.error(error.response.body); }); name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.removeCustomFieldSettingForPortfolio(portfolioGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class portfolios_api_instance = asana.PortfoliosApi(api_client) body = {"data": {"": "", "": "",}} # dict | Information about the custom field setting being removed. portfolio_gid = "12345" # str | Globally unique identifier for the portfolio. try: # Remove a custom field from a portfolio api_response = portfolios_api_instance.remove_custom_field_setting_for_portfolio(body, portfolio_gid) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->remove_custom_field_setting_for_portfolio: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.remove_custom_field_setting_for_portfolio(portfolio_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- portfolios->removeCustomFieldSettingForPortfolio($portfolio_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.remove_custom_field_setting_for_portfolio(portfolio_gid: 'portfolio_gid', field: "value", field: "value", options: {pretty: true}) /portfolios/{portfolioGid}/addMembers: post: tags: - Portfolios summary: Add users to a portfolio description: |- Adds the specified list of users as members of the portfolio. Returns the updated portfolio record. operationId: addMembersForPortfolio parameters: - name: portfolioGid in: path description: Globally unique identifier for the portfolio. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: portfolio - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.id_prefix - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.representation_type - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.id_prefix - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.representation_type - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name example: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.id_prefix - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.representation_type - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.id_prefix - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.representation_type - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name x-ballerina-name: optFields requestBody: description: Information about the members being added. content: application/json: schema: $ref: '#/components/schemas/PortfolioGidAddMembersBody' required: true responses: "200": description: Successfully added members to the portfolio. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2014' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Portfolio result = client.portfolios.addMembersForPortfolio(portfolioGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet portfoliosApiInstance = new Asana.PortfoliosApi();\nlet body = {\"\ data\": {\"\": \"\", \"\": \"\",}};\ \ // Object | Information about the members being added.\nlet portfolio_gid\ \ = \"12345\"; // String | Globally unique identifier for the portfolio.\n\ let opts = { \n 'opt_fields': \"color,created_at,created_by,created_by.name,current_status_update,current_status_update.resource_subtype,current_status_update.title,custom_field_settings,custom_field_settings.custom_field,custom_field_settings.custom_field.asana_created_field,custom_field_settings.custom_field.created_by,custom_field_settings.custom_field.created_by.name,custom_field_settings.custom_field.currency_code,custom_field_settings.custom_field.custom_label,custom_field_settings.custom_field.custom_label_position,custom_field_settings.custom_field.date_value,custom_field_settings.custom_field.date_value.date,custom_field_settings.custom_field.date_value.date_time,custom_field_settings.custom_field.description,custom_field_settings.custom_field.display_value,custom_field_settings.custom_field.enabled,custom_field_settings.custom_field.enum_options,custom_field_settings.custom_field.enum_options.color,custom_field_settings.custom_field.enum_options.enabled,custom_field_settings.custom_field.enum_options.name,custom_field_settings.custom_field.enum_value,custom_field_settings.custom_field.enum_value.color,custom_field_settings.custom_field.enum_value.enabled,custom_field_settings.custom_field.enum_value.name,custom_field_settings.custom_field.format,custom_field_settings.custom_field.has_notifications_enabled,custom_field_settings.custom_field.is_formula_field,custom_field_settings.custom_field.is_global_to_workspace,custom_field_settings.custom_field.is_value_read_only,custom_field_settings.custom_field.multi_enum_values,custom_field_settings.custom_field.multi_enum_values.color,custom_field_settings.custom_field.multi_enum_values.enabled,custom_field_settings.custom_field.multi_enum_values.name,custom_field_settings.custom_field.name,custom_field_settings.custom_field.number_value,custom_field_settings.custom_field.people_value,custom_field_settings.custom_field.people_value.name,custom_field_settings.custom_field.precision,custom_field_settings.custom_field.resource_subtype,custom_field_settings.custom_field.text_value,custom_field_settings.custom_field.type,custom_field_settings.is_important,custom_field_settings.parent,custom_field_settings.parent.name,custom_field_settings.project,custom_field_settings.project.name,custom_fields,custom_fields.date_value,custom_fields.date_value.date,custom_fields.date_value.date_time,custom_fields.display_value,custom_fields.enabled,custom_fields.enum_options,custom_fields.enum_options.color,custom_fields.enum_options.enabled,custom_fields.enum_options.name,custom_fields.enum_value,custom_fields.enum_value.color,custom_fields.enum_value.enabled,custom_fields.enum_value.name,custom_fields.is_formula_field,custom_fields.multi_enum_values,custom_fields.multi_enum_values.color,custom_fields.multi_enum_values.enabled,custom_fields.multi_enum_values.name,custom_fields.name,custom_fields.number_value,custom_fields.resource_subtype,custom_fields.text_value,custom_fields.type,due_on,members,members.name,name,owner,owner.name,permalink_url,project_templates,project_templates.name,public,start_on,workspace,workspace.name\"\ \n};\nportfoliosApiInstance.addMembersForPortfolio(body, portfolio_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.addMembersForPortfolio(portfolioGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class portfolios_api_instance = asana.PortfoliosApi(api_client) body = {"data": {"": "", "": "",}} # dict | Information about the members being added. portfolio_gid = "12345" # str | Globally unique identifier for the portfolio. opts = { 'opt_fields': "color,created_at,created_by,created_by.name,current_status_update,current_status_update.resource_subtype,current_status_update.title,custom_field_settings,custom_field_settings.custom_field,custom_field_settings.custom_field.asana_created_field,custom_field_settings.custom_field.created_by,custom_field_settings.custom_field.created_by.name,custom_field_settings.custom_field.currency_code,custom_field_settings.custom_field.custom_label,custom_field_settings.custom_field.custom_label_position,custom_field_settings.custom_field.date_value,custom_field_settings.custom_field.date_value.date,custom_field_settings.custom_field.date_value.date_time,custom_field_settings.custom_field.description,custom_field_settings.custom_field.display_value,custom_field_settings.custom_field.enabled,custom_field_settings.custom_field.enum_options,custom_field_settings.custom_field.enum_options.color,custom_field_settings.custom_field.enum_options.enabled,custom_field_settings.custom_field.enum_options.name,custom_field_settings.custom_field.enum_value,custom_field_settings.custom_field.enum_value.color,custom_field_settings.custom_field.enum_value.enabled,custom_field_settings.custom_field.enum_value.name,custom_field_settings.custom_field.format,custom_field_settings.custom_field.has_notifications_enabled,custom_field_settings.custom_field.id_prefix,custom_field_settings.custom_field.is_formula_field,custom_field_settings.custom_field.is_global_to_workspace,custom_field_settings.custom_field.is_value_read_only,custom_field_settings.custom_field.multi_enum_values,custom_field_settings.custom_field.multi_enum_values.color,custom_field_settings.custom_field.multi_enum_values.enabled,custom_field_settings.custom_field.multi_enum_values.name,custom_field_settings.custom_field.name,custom_field_settings.custom_field.number_value,custom_field_settings.custom_field.people_value,custom_field_settings.custom_field.people_value.name,custom_field_settings.custom_field.precision,custom_field_settings.custom_field.representation_type,custom_field_settings.custom_field.resource_subtype,custom_field_settings.custom_field.text_value,custom_field_settings.custom_field.type,custom_field_settings.is_important,custom_field_settings.parent,custom_field_settings.parent.name,custom_field_settings.project,custom_field_settings.project.name,custom_fields,custom_fields.date_value,custom_fields.date_value.date,custom_fields.date_value.date_time,custom_fields.display_value,custom_fields.enabled,custom_fields.enum_options,custom_fields.enum_options.color,custom_fields.enum_options.enabled,custom_fields.enum_options.name,custom_fields.enum_value,custom_fields.enum_value.color,custom_fields.enum_value.enabled,custom_fields.enum_value.name,custom_fields.id_prefix,custom_fields.is_formula_field,custom_fields.multi_enum_values,custom_fields.multi_enum_values.color,custom_fields.multi_enum_values.enabled,custom_fields.multi_enum_values.name,custom_fields.name,custom_fields.number_value,custom_fields.representation_type,custom_fields.resource_subtype,custom_fields.text_value,custom_fields.type,due_on,members,members.name,name,owner,owner.name,permalink_url,project_templates,project_templates.name,public,start_on,workspace,workspace.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Add users to a portfolio api_response = portfolios_api_instance.add_members_for_portfolio(body, portfolio_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->add_members_for_portfolio: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.add_members_for_portfolio(portfolio_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- portfolios->addMembersForPortfolio($portfolio_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.add_members_for_portfolio(portfolio_gid: 'portfolio_gid', field: "value", field: "value", options: {pretty: true}) /portfolios/{portfolioGid}/removeMembers: post: tags: - Portfolios summary: Remove users from a portfolio description: |- Removes the specified list of users from members of the portfolio. Returns the updated portfolio record. operationId: removeMembersForPortfolio parameters: - name: portfolioGid in: path description: Globally unique identifier for the portfolio. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: portfolio - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.id_prefix - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.representation_type - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.id_prefix - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.representation_type - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name example: - color - created_at - created_by - created_by.name - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.id_prefix - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.representation_type - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.id_prefix - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.representation_type - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - due_on - members - members.name - name - owner - owner.name - permalink_url - project_templates - project_templates.name - public - start_on - workspace - workspace.name x-ballerina-name: optFields requestBody: description: Information about the members being removed. content: application/json: schema: $ref: '#/components/schemas/PortfolioGidRemoveMembersBody' required: true responses: "200": description: Successfully removed the members from the portfolio. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2014' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Portfolio result = client.portfolios.removeMembersForPortfolio(portfolioGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet portfoliosApiInstance = new Asana.PortfoliosApi();\nlet body = {\"\ data\": {\"\": \"\", \"\": \"\",}};\ \ // Object | Information about the members being removed.\nlet portfolio_gid\ \ = \"12345\"; // String | Globally unique identifier for the portfolio.\n\ let opts = { \n 'opt_fields': \"color,created_at,created_by,created_by.name,current_status_update,current_status_update.resource_subtype,current_status_update.title,custom_field_settings,custom_field_settings.custom_field,custom_field_settings.custom_field.asana_created_field,custom_field_settings.custom_field.created_by,custom_field_settings.custom_field.created_by.name,custom_field_settings.custom_field.currency_code,custom_field_settings.custom_field.custom_label,custom_field_settings.custom_field.custom_label_position,custom_field_settings.custom_field.date_value,custom_field_settings.custom_field.date_value.date,custom_field_settings.custom_field.date_value.date_time,custom_field_settings.custom_field.description,custom_field_settings.custom_field.display_value,custom_field_settings.custom_field.enabled,custom_field_settings.custom_field.enum_options,custom_field_settings.custom_field.enum_options.color,custom_field_settings.custom_field.enum_options.enabled,custom_field_settings.custom_field.enum_options.name,custom_field_settings.custom_field.enum_value,custom_field_settings.custom_field.enum_value.color,custom_field_settings.custom_field.enum_value.enabled,custom_field_settings.custom_field.enum_value.name,custom_field_settings.custom_field.format,custom_field_settings.custom_field.has_notifications_enabled,custom_field_settings.custom_field.is_formula_field,custom_field_settings.custom_field.is_global_to_workspace,custom_field_settings.custom_field.is_value_read_only,custom_field_settings.custom_field.multi_enum_values,custom_field_settings.custom_field.multi_enum_values.color,custom_field_settings.custom_field.multi_enum_values.enabled,custom_field_settings.custom_field.multi_enum_values.name,custom_field_settings.custom_field.name,custom_field_settings.custom_field.number_value,custom_field_settings.custom_field.people_value,custom_field_settings.custom_field.people_value.name,custom_field_settings.custom_field.precision,custom_field_settings.custom_field.resource_subtype,custom_field_settings.custom_field.text_value,custom_field_settings.custom_field.type,custom_field_settings.is_important,custom_field_settings.parent,custom_field_settings.parent.name,custom_field_settings.project,custom_field_settings.project.name,custom_fields,custom_fields.date_value,custom_fields.date_value.date,custom_fields.date_value.date_time,custom_fields.display_value,custom_fields.enabled,custom_fields.enum_options,custom_fields.enum_options.color,custom_fields.enum_options.enabled,custom_fields.enum_options.name,custom_fields.enum_value,custom_fields.enum_value.color,custom_fields.enum_value.enabled,custom_fields.enum_value.name,custom_fields.is_formula_field,custom_fields.multi_enum_values,custom_fields.multi_enum_values.color,custom_fields.multi_enum_values.enabled,custom_fields.multi_enum_values.name,custom_fields.name,custom_fields.number_value,custom_fields.resource_subtype,custom_fields.text_value,custom_fields.type,due_on,members,members.name,name,owner,owner.name,permalink_url,project_templates,project_templates.name,public,start_on,workspace,workspace.name\"\ \n};\nportfoliosApiInstance.removeMembersForPortfolio(body, portfolio_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.portfolios.removeMembersForPortfolio(portfolioGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class portfolios_api_instance = asana.PortfoliosApi(api_client) body = {"data": {"": "", "": "",}} # dict | Information about the members being removed. portfolio_gid = "12345" # str | Globally unique identifier for the portfolio. opts = { 'opt_fields': "color,created_at,created_by,created_by.name,current_status_update,current_status_update.resource_subtype,current_status_update.title,custom_field_settings,custom_field_settings.custom_field,custom_field_settings.custom_field.asana_created_field,custom_field_settings.custom_field.created_by,custom_field_settings.custom_field.created_by.name,custom_field_settings.custom_field.currency_code,custom_field_settings.custom_field.custom_label,custom_field_settings.custom_field.custom_label_position,custom_field_settings.custom_field.date_value,custom_field_settings.custom_field.date_value.date,custom_field_settings.custom_field.date_value.date_time,custom_field_settings.custom_field.description,custom_field_settings.custom_field.display_value,custom_field_settings.custom_field.enabled,custom_field_settings.custom_field.enum_options,custom_field_settings.custom_field.enum_options.color,custom_field_settings.custom_field.enum_options.enabled,custom_field_settings.custom_field.enum_options.name,custom_field_settings.custom_field.enum_value,custom_field_settings.custom_field.enum_value.color,custom_field_settings.custom_field.enum_value.enabled,custom_field_settings.custom_field.enum_value.name,custom_field_settings.custom_field.format,custom_field_settings.custom_field.has_notifications_enabled,custom_field_settings.custom_field.id_prefix,custom_field_settings.custom_field.is_formula_field,custom_field_settings.custom_field.is_global_to_workspace,custom_field_settings.custom_field.is_value_read_only,custom_field_settings.custom_field.multi_enum_values,custom_field_settings.custom_field.multi_enum_values.color,custom_field_settings.custom_field.multi_enum_values.enabled,custom_field_settings.custom_field.multi_enum_values.name,custom_field_settings.custom_field.name,custom_field_settings.custom_field.number_value,custom_field_settings.custom_field.people_value,custom_field_settings.custom_field.people_value.name,custom_field_settings.custom_field.precision,custom_field_settings.custom_field.representation_type,custom_field_settings.custom_field.resource_subtype,custom_field_settings.custom_field.text_value,custom_field_settings.custom_field.type,custom_field_settings.is_important,custom_field_settings.parent,custom_field_settings.parent.name,custom_field_settings.project,custom_field_settings.project.name,custom_fields,custom_fields.date_value,custom_fields.date_value.date,custom_fields.date_value.date_time,custom_fields.display_value,custom_fields.enabled,custom_fields.enum_options,custom_fields.enum_options.color,custom_fields.enum_options.enabled,custom_fields.enum_options.name,custom_fields.enum_value,custom_fields.enum_value.color,custom_fields.enum_value.enabled,custom_fields.enum_value.name,custom_fields.id_prefix,custom_fields.is_formula_field,custom_fields.multi_enum_values,custom_fields.multi_enum_values.color,custom_fields.multi_enum_values.enabled,custom_fields.multi_enum_values.name,custom_fields.name,custom_fields.number_value,custom_fields.representation_type,custom_fields.resource_subtype,custom_fields.text_value,custom_fields.type,due_on,members,members.name,name,owner,owner.name,permalink_url,project_templates,project_templates.name,public,start_on,workspace,workspace.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Remove users from a portfolio api_response = portfolios_api_instance.remove_members_for_portfolio(body, portfolio_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling PortfoliosApi->remove_members_for_portfolio: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.portfolios.remove_members_for_portfolio(portfolio_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- portfolios->removeMembersForPortfolio($portfolio_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.portfolios.remove_members_for_portfolio(portfolio_gid: 'portfolio_gid', field: "value", field: "value", options: {pretty: true}) /project_briefs/{projectBriefGid}: get: tags: - Project briefs summary: Get a project brief description: Get the full record for a project brief. operationId: getProjectBrief parameters: - name: projectBriefGid in: path description: Globally unique identifier for the project brief. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: project_brief - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - html_text - permalink_url - project - project.name - text - title example: - html_text - permalink_url - project - project.name - text - title x-ballerina-name: optFields responses: "200": description: Successfully retrieved the record for a project brief. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20021' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "402": description: "The request was valid, but the queried object or object mutation\ \ specified in the request is above your current premium level." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "424": description: "You have exceeded one of the enforced rate limits in the API.\ \ See the [documentation on rate limiting](https://developers.asana.com/docs/#rate-limits)\ \ for more information." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "501": description: There is an issue between the load balancers and Asana's API. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "503": description: "Either the upstream service is unavailable to the API, or\ \ the API has been intentionally shut off." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "504": description: This request took too long to complete. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.projectbriefs.getProjectBrief(projectBriefGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet projectBriefsApiInstance = new Asana.ProjectBriefsApi();\nlet project_brief_gid\ \ = \"12345\"; // String | Globally unique identifier for the project\ \ brief.\nlet opts = { \n 'opt_fields': \"html_text,permalink_url,project,project.name,text,title\"\ \n};\nprojectBriefsApiInstance.getProjectBrief(project_brief_gid, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectbriefs.getProjectBrief(projectBriefGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class project_briefs_api_instance = asana.ProjectBriefsApi(api_client) project_brief_gid = "12345" # str | Globally unique identifier for the project brief. opts = { 'opt_fields': "html_text,permalink_url,project,project.name,text,title", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get a project brief api_response = project_briefs_api_instance.get_project_brief(project_brief_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling ProjectBriefsApi->get_project_brief: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_briefs.get_project_brief(project_brief_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- projectbriefs->getProjectBrief($project_brief_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_briefs.get_project_brief(project_brief_gid: 'project_brief_gid', param: "value", param: "value", options: {pretty: true}) put: tags: - Project briefs summary: Update a project brief description: |- An existing project brief can be updated by making a PUT request on the URL for that project brief. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Returns the complete updated project brief record. operationId: updateProjectBrief parameters: - name: projectBriefGid in: path description: Globally unique identifier for the project brief. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: project_brief - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - html_text - permalink_url - project - project.name - text - title example: - html_text - permalink_url - project - project.name - text - title x-ballerina-name: optFields requestBody: description: The updated fields for the project brief. content: application/json: schema: $ref: '#/components/schemas/ProjectBriefsprojectBriefGidBody' required: true responses: "200": description: Successfully updated the project brief. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20021' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.projectbriefs.updateProjectBrief(projectBriefGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet projectBriefsApiInstance = new Asana.ProjectBriefsApi();\nlet body\ \ = {\"data\": {\"\": \"\", \"\": \"\"\ ,}}; // Object | The updated fields for the project brief.\nlet project_brief_gid\ \ = \"12345\"; // String | Globally unique identifier for the project\ \ brief.\nlet opts = { \n 'opt_fields': \"html_text,permalink_url,project,project.name,text,title\"\ \n};\nprojectBriefsApiInstance.updateProjectBrief(body, project_brief_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectbriefs.updateProjectBrief(projectBriefGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class project_briefs_api_instance = asana.ProjectBriefsApi(api_client) body = {"data": {"": "", "": "",}} # dict | The updated fields for the project brief. project_brief_gid = "12345" # str | Globally unique identifier for the project brief. opts = { 'opt_fields': "html_text,permalink_url,project,project.name,text,title", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Update a project brief api_response = project_briefs_api_instance.update_project_brief(body, project_brief_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling ProjectBriefsApi->update_project_brief: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_briefs.update_project_brief(project_brief_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- projectbriefs->updateProjectBrief($project_brief_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_briefs.update_project_brief(project_brief_gid: 'project_brief_gid', field: "value", field: "value", options: {pretty: true}) delete: tags: - Project briefs summary: Delete a project brief description: |- Deletes a specific, existing project brief. Returns an empty data record. operationId: deleteProjectBrief parameters: - name: projectBriefGid in: path description: Globally unique identifier for the project brief. required: true style: simple explode: false schema: type: string example: "12345" x-env-variable: project_brief - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty responses: "200": description: Successfully deleted the specified project brief. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2001' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.projectbriefs.deleteProjectBrief(projectBriefGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: |- const Asana = require('asana'); let client = Asana.ApiClient.instance; let token = client.authentications['token']; token.accessToken = ''; let projectBriefsApiInstance = new Asana.ProjectBriefsApi(); let project_brief_gid = "12345"; // String | Globally unique identifier for the project brief. projectBriefsApiInstance.deleteProjectBrief(project_brief_gid).then((result) => { console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2)); }, (error) => { console.error(error.response.body); }); name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectbriefs.deleteProjectBrief(projectBriefGid) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class project_briefs_api_instance = asana.ProjectBriefsApi(api_client) project_brief_gid = "12345" # str | Globally unique identifier for the project brief. try: # Delete a project brief api_response = project_briefs_api_instance.delete_project_brief(project_brief_gid) pprint(api_response) except ApiException as e: print("Exception when calling ProjectBriefsApi->delete_project_brief: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_briefs.delete_project_brief(project_brief_gid, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- projectbriefs->deleteProjectBrief($project_brief_gid, array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_briefs.delete_project_brief(project_brief_gid: 'project_brief_gid', options: {pretty: true}) /projects/{projectGid}/project_briefs: post: tags: - Project briefs summary: Create a project brief description: |- Creates a new project brief. Returns the full record of the newly created project brief. operationId: createProjectBrief parameters: - name: projectGid in: path description: Globally unique identifier for the project. required: true style: simple explode: false schema: type: string example: "1331" x-env-variable: project - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - html_text - permalink_url - project - project.name - text - title example: - html_text - permalink_url - project - project.name - text - title x-ballerina-name: optFields requestBody: description: The project brief to create. content: application/json: schema: $ref: '#/components/schemas/ProjectGidProjectBriefsBody' required: true responses: "201": description: Successfully created a new project brief. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20021' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "402": description: "The request was valid, but the queried object or object mutation\ \ specified in the request is above your current premium level." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.projectbriefs.createProjectBrief(projectGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet projectBriefsApiInstance = new Asana.ProjectBriefsApi();\nlet body\ \ = {\"data\": {\"\": \"\", \"\": \"\"\ ,}}; // Object | The project brief to create.\nlet project_gid = \"1331\"\ ; // String | Globally unique identifier for the project.\nlet opts =\ \ { \n 'opt_fields': \"html_text,permalink_url,project,project.name,text,title\"\ \n};\nprojectBriefsApiInstance.createProjectBrief(body, project_gid, opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectbriefs.createProjectBrief(projectGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class project_briefs_api_instance = asana.ProjectBriefsApi(api_client) body = {"data": {"": "", "": "",}} # dict | The project brief to create. project_gid = "1331" # str | Globally unique identifier for the project. opts = { 'opt_fields': "html_text,permalink_url,project,project.name,text,title", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Create a project brief api_response = project_briefs_api_instance.create_project_brief(body, project_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling ProjectBriefsApi->create_project_brief: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_briefs.create_project_brief(project_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- projectbriefs->createProjectBrief($project_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_briefs.create_project_brief(project_gid: 'project_gid', field: "value", field: "value", options: {pretty: true}) /project_memberships/{projectMembershipGid}: get: tags: - Project memberships summary: Get a project membership description: Returns the complete project record for a single project membership. operationId: getProjectMembership parameters: - name: projectMembershipGid in: path required: true style: simple explode: false schema: type: string example: "1331" x-env-variable: project_membership - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - access_level - member - member.name - parent - parent.name - project - project.name - user - user.name - write_access example: - access_level - member - member.name - parent - parent.name - project - project.name - user - user.name - write_access x-ballerina-name: optFields responses: "200": description: Successfully retrieved the requested project membership. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20022' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); ProjectMembership result = client.projectmemberships.getProjectMembership(projectMembershipGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet projectMembershipsApiInstance = new Asana.ProjectMembershipsApi();\n\ let project_membership_gid = \"1331\"; // String | \nlet opts = { \n \ \ 'opt_fields': \"access_level,member,member.name,parent,parent.name,project,project.name,user,user.name,write_access\"\ \n};\nprojectMembershipsApiInstance.getProjectMembership(project_membership_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectmemberships.getProjectMembership(projectMembershipGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: "import asana\nfrom asana.rest import ApiException\nfrom pprint import\ \ pprint\n\nconfiguration = asana.Configuration()\nconfiguration.access_token\ \ = ''\napi_client = asana.ApiClient(configuration)\n\ \n# create an instance of the API class\nproject_memberships_api_instance\ \ = asana.ProjectMembershipsApi(api_client)\nproject_membership_gid =\ \ \"1331\" # str | \nopts = {\n 'opt_fields': \"access_level,member,member.name,parent,parent.name,project,project.name,user,user.name,write_access\"\ , # list[str] | This endpoint returns a compact resource, which excludes\ \ some properties by default. To include those optional properties, set\ \ this query parameter to a comma-separated list of the properties you\ \ wish to include.\n}\n\ntry:\n # Get a project membership\n api_response\ \ = project_memberships_api_instance.get_project_membership(project_membership_gid,\ \ opts)\n pprint(api_response)\nexcept ApiException as e:\n print(\"\ Exception when calling ProjectMembershipsApi->get_project_membership:\ \ %s\\n\" % e)" name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_memberships.get_project_membership(project_membership_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- projectmemberships->getProjectMembership($project_membership_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_memberships.get_project_membership(project_membership_gid: 'project_membership_gid', param: "value", param: "value", options: {pretty: true}) /projects/{projectGid}/project_memberships: get: tags: - Project memberships summary: Get memberships from a project description: Returns the compact project membership records for the project. operationId: getProjectMembershipsForProject parameters: - name: projectGid in: path description: Globally unique identifier for the project. required: true style: simple explode: false schema: type: string example: "1331" x-env-variable: project - name: user in: query description: "A string identifying a user. This can either be the string \"\ me\", an email, or the gid of a user." required: false style: form explode: true schema: type: string example: me x-env-variable: user - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: limit in: query description: |- Results per page. The number of objects to return per page. The value must be between 1 and 100. required: false style: form explode: true schema: maximum: 100 minimum: 1 type: integer example: 50 - name: offset in: query description: |- Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' required: false style: form explode: true schema: type: string example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - access_level - member - member.name - offset - parent - parent.name - path - uri example: - access_level - member - member.name - offset - parent - parent.name - path - uri x-ballerina-name: optFields responses: "200": description: Successfully retrieved the requested project's memberships. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20023' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.projectmemberships.getProjectMembershipsForProject(projectGid, user) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet projectMembershipsApiInstance = new Asana.ProjectMembershipsApi();\n\ let project_gid = \"1331\"; // String | Globally unique identifier for\ \ the project.\nlet opts = { \n 'user': \"me\", \n 'limit': 50,\ \ \n 'offset': \"eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9\", \n 'opt_fields':\ \ \"access_level,member,member.name,offset,parent,parent.name,path,uri\"\ \n};\nprojectMembershipsApiInstance.getProjectMembershipsForProject(project_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectmemberships.getProjectMembershipsForProject(projectGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class project_memberships_api_instance = asana.ProjectMembershipsApi(api_client) project_gid = "1331" # str | Globally unique identifier for the project. opts = { 'user': "me", # str | A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. 'limit': 50, # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': "access_level,member,member.name,offset,parent,parent.name,path,uri", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get memberships from a project api_response = project_memberships_api_instance.get_project_memberships_for_project(project_gid, opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling ProjectMembershipsApi->get_project_memberships_for_project: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_memberships.get_project_memberships_for_project(project_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- projectmemberships->getProjectMembershipsForProject($project_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_memberships.get_project_memberships_for_project(project_gid: 'project_gid', param: "value", param: "value", options: {pretty: true}) /project_statuses/{projectStatusGid}: get: tags: - Project statuses summary: Get a project status description: |- *Deprecated: new integrations should prefer the `/status_updates/{status_gid}` route.* Returns the complete record for a single status update. operationId: getProjectStatus parameters: - name: projectStatusGid in: path description: The project status update to get. required: true style: simple explode: false schema: type: string example: "321654" x-env-variable: project_status - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - author - author.name - color - created_at - created_by - created_by.name - html_text - modified_at - text - title example: - author - author.name - color - created_at - created_by - created_by.name - html_text - modified_at - text - title x-ballerina-name: optFields responses: "200": description: Successfully retrieved the specified project's status updates. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20024' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); ProjectStatus result = client.projectstatuses.getProjectStatus(projectStatusGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet projectStatusesApiInstance = new Asana.ProjectStatusesApi();\nlet\ \ project_status_gid = \"321654\"; // String | The project status update\ \ to get.\nlet opts = { \n 'opt_fields': \"author,author.name,color,created_at,created_by,created_by.name,html_text,modified_at,text,title\"\ \n};\nprojectStatusesApiInstance.getProjectStatus(project_status_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectstatuses.getProjectStatus(projectStatusGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class project_statuses_api_instance = asana.ProjectStatusesApi(api_client) project_status_gid = "321654" # str | The project status update to get. opts = { 'opt_fields': "author,author.name,color,created_at,created_by,created_by.name,html_text,modified_at,text,title", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get a project status api_response = project_statuses_api_instance.get_project_status(project_status_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling ProjectStatusesApi->get_project_status: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_statuses.get_project_status(project_status_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- projectstatuses->getProjectStatus($project_status_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_statuses.get_project_status(project_status_gid: 'project_status_gid', param: "value", param: "value", options: {pretty: true}) delete: tags: - Project statuses summary: Delete a project status description: |- *Deprecated: new integrations should prefer the `/status_updates/{status_gid}` route.* Deletes a specific, existing project status update. Returns an empty data record. operationId: deleteProjectStatus parameters: - name: projectStatusGid in: path description: The project status update to get. required: true style: simple explode: false schema: type: string example: "321654" x-env-variable: project_status - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty responses: "200": description: Successfully deleted the specified project status. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2001' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.projectstatuses.deleteProjectStatus(projectStatusGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: |- const Asana = require('asana'); let client = Asana.ApiClient.instance; let token = client.authentications['token']; token.accessToken = ''; let projectStatusesApiInstance = new Asana.ProjectStatusesApi(); let project_status_gid = "321654"; // String | The project status update to get. projectStatusesApiInstance.deleteProjectStatus(project_status_gid).then((result) => { console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2)); }, (error) => { console.error(error.response.body); }); name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectstatuses.deleteProjectStatus(projectStatusGid) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class project_statuses_api_instance = asana.ProjectStatusesApi(api_client) project_status_gid = "321654" # str | The project status update to get. try: # Delete a project status api_response = project_statuses_api_instance.delete_project_status(project_status_gid) pprint(api_response) except ApiException as e: print("Exception when calling ProjectStatusesApi->delete_project_status: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_statuses.delete_project_status(project_status_gid, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- projectstatuses->deleteProjectStatus($project_status_gid, array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_statuses.delete_project_status(project_status_gid: 'project_status_gid', options: {pretty: true}) /projects/{projectGid}/project_statuses: get: tags: - Project statuses summary: Get statuses from a project description: |- *Deprecated: new integrations should prefer the `/status_updates` route.* Returns the compact project status update records for all updates on the project. operationId: getProjectStatusesForProject parameters: - name: projectGid in: path description: Globally unique identifier for the project. required: true style: simple explode: false schema: type: string example: "1331" x-env-variable: project - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: limit in: query description: |- Results per page. The number of objects to return per page. The value must be between 1 and 100. required: false style: form explode: true schema: maximum: 100 minimum: 1 type: integer example: 50 - name: offset in: query description: |- Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' required: false style: form explode: true schema: type: string example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - author - author.name - color - created_at - created_by - created_by.name - html_text - modified_at - offset - path - text - title - uri example: - author - author.name - color - created_at - created_by - created_by.name - html_text - modified_at - offset - path - text - title - uri x-ballerina-name: optFields responses: "200": description: Successfully retrieved the specified project's status updates. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20025' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.projectstatuses.getProjectStatusesForProject(projectGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet projectStatusesApiInstance = new Asana.ProjectStatusesApi();\nlet\ \ project_gid = \"1331\"; // String | Globally unique identifier for the\ \ project.\nlet opts = { \n 'limit': 50, \n 'offset': \"eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9\"\ , \n 'opt_fields': \"author,author.name,color,created_at,created_by,created_by.name,html_text,modified_at,offset,path,text,title,uri\"\ \n};\nprojectStatusesApiInstance.getProjectStatusesForProject(project_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectstatuses.getProjectStatusesForProject(projectGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class project_statuses_api_instance = asana.ProjectStatusesApi(api_client) project_gid = "1331" # str | Globally unique identifier for the project. opts = { 'limit': 50, # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': "author,author.name,color,created_at,created_by,created_by.name,html_text,modified_at,offset,path,text,title,uri", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get statuses from a project api_response = project_statuses_api_instance.get_project_statuses_for_project(project_gid, opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling ProjectStatusesApi->get_project_statuses_for_project: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_statuses.get_project_statuses_for_project(project_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- projectstatuses->getProjectStatusesForProject($project_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_statuses.get_project_statuses_for_project(project_gid: 'project_gid', param: "value", param: "value", options: {pretty: true}) post: tags: - Project statuses summary: Create a project status description: |- *Deprecated: new integrations should prefer the `/status_updates` route.* Creates a new status update on the project. Returns the full record of the newly created project status update. operationId: createProjectStatusForProject parameters: - name: projectGid in: path description: Globally unique identifier for the project. required: true style: simple explode: false schema: type: string example: "1331" x-env-variable: project - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - author - author.name - color - created_at - created_by - created_by.name - html_text - modified_at - text - title example: - author - author.name - color - created_at - created_by - created_by.name - html_text - modified_at - text - title x-ballerina-name: optFields requestBody: description: The project status to create. content: application/json: schema: $ref: '#/components/schemas/ProjectGidProjectStatusesBody' required: true responses: "201": description: Successfully created a new story. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20024' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); ProjectStatus result = client.projectstatuses.createProjectStatusForProject(projectGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet projectStatusesApiInstance = new Asana.ProjectStatusesApi();\nlet\ \ body = {\"data\": {\"\": \"\", \"\": \"\"\ ,}}; // Object | The project status to create.\nlet project_gid = \"1331\"\ ; // String | Globally unique identifier for the project.\nlet opts =\ \ { \n 'opt_fields': \"author,author.name,color,created_at,created_by,created_by.name,html_text,modified_at,text,title\"\ \n};\nprojectStatusesApiInstance.createProjectStatusForProject(body, project_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projectstatuses.createProjectStatusForProject(projectGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class project_statuses_api_instance = asana.ProjectStatusesApi(api_client) body = {"data": {"": "", "": "",}} # dict | The project status to create. project_gid = "1331" # str | Globally unique identifier for the project. opts = { 'opt_fields': "author,author.name,color,created_at,created_by,created_by.name,html_text,modified_at,text,title", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Create a project status api_response = project_statuses_api_instance.create_project_status_for_project(body, project_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling ProjectStatusesApi->create_project_status_for_project: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_statuses.create_project_status_for_project(project_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- projectstatuses->createProjectStatusForProject($project_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_statuses.create_project_status_for_project(project_gid: 'project_gid', field: "value", field: "value", options: {pretty: true}) /project_templates/{projectTemplateGid}: get: tags: - Project templates summary: Get a project template description: Returns the complete project template record for a single project template. operationId: getProjectTemplate parameters: - name: projectTemplateGid in: path description: Globally unique identifier for the project template. required: true style: simple explode: false schema: type: string example: "1331" x-env-variable: project_template - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - color - description - html_description - name - owner - public - requested_dates - requested_dates.description - requested_dates.name - requested_roles - requested_roles.name - team - team.name example: - color - description - html_description - name - owner - public - requested_dates - requested_dates.description - requested_dates.name - requested_roles - requested_roles.name - team - team.name x-ballerina-name: optFields responses: "200": description: Successfully retrieved the requested project template. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20026' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); JsonElement result = client.projecttemplates.getProjectTemplate(projectTemplateGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet projectTemplatesApiInstance = new Asana.ProjectTemplatesApi();\n\ let project_template_gid = \"1331\"; // String | Globally unique identifier\ \ for the project template.\nlet opts = { \n 'opt_fields': \"color,description,html_description,name,owner,public,requested_dates,requested_dates.description,requested_dates.name,requested_roles,requested_roles.name,team,team.name\"\ \n};\nprojectTemplatesApiInstance.getProjectTemplate(project_template_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projecttemplates.getProjectTemplate(projectTemplateGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class project_templates_api_instance = asana.ProjectTemplatesApi(api_client) project_template_gid = "1331" # str | Globally unique identifier for the project template. opts = { 'opt_fields': "color,description,html_description,name,owner,public,requested_dates,requested_dates.description,requested_dates.name,requested_roles,requested_roles.name,team,team.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get a project template api_response = project_templates_api_instance.get_project_template(project_template_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling ProjectTemplatesApi->get_project_template: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_templates.get_project_template(project_template_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- projecttemplates->getProjectTemplate($project_template_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_templates.get_project_template(project_template_gid: 'project_template_gid', param: "value", param: "value", options: {pretty: true}) delete: tags: - Project templates summary: Delete a project template description: |- A specific, existing project template can be deleted by making a DELETE request on the URL for that project template. Returns an empty data record. operationId: deleteProjectTemplate parameters: - name: projectTemplateGid in: path description: Globally unique identifier for the project template. required: true style: simple explode: false schema: type: string example: "1331" x-env-variable: project_template - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty responses: "200": description: Successfully deleted the specified project template. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2001' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "402": description: "The request was valid, but the queried object or object mutation\ \ specified in the request is above your current premium level." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: node install: npm install asana code: |- const Asana = require('asana'); let client = Asana.ApiClient.instance; let token = client.authentications['token']; token.accessToken = ''; let projectTemplatesApiInstance = new Asana.ProjectTemplatesApi(); let project_template_gid = "1331"; // String | Globally unique identifier for the project template. projectTemplatesApiInstance.deleteProjectTemplate(project_template_gid).then((result) => { console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2)); }, (error) => { console.error(error.response.body); }); name: node-sdk-v3 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class project_templates_api_instance = asana.ProjectTemplatesApi(api_client) project_template_gid = "1331" # str | Globally unique identifier for the project template. try: # Delete a project template api_response = project_templates_api_instance.delete_project_template(project_template_gid) pprint(api_response) except ApiException as e: print("Exception when calling ProjectTemplatesApi->delete_project_template: %s\n" % e) name: python-sdk-v5 /project_templates: get: tags: - Project templates summary: Get multiple project templates description: Returns the compact project template records for all project templates in the given team or workspace. operationId: getProjectTemplates parameters: - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: workspace in: query description: The workspace to filter results on. required: false style: form explode: true schema: type: string example: "12345" x-env-variable: workspace - name: team in: query description: The team to filter projects on. required: false style: form explode: true schema: type: string example: "14916" x-env-variable: team - name: limit in: query description: |- Results per page. The number of objects to return per page. The value must be between 1 and 100. required: false style: form explode: true schema: maximum: 100 minimum: 1 type: integer example: 50 - name: offset in: query description: |- Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' required: false style: form explode: true schema: type: string example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - color - description - html_description - name - offset - owner - path - public - requested_dates - requested_dates.description - requested_dates.name - requested_roles - requested_roles.name - team - team.name - uri example: - color - description - html_description - name - offset - owner - path - public - requested_dates - requested_dates.description - requested_dates.name - requested_roles - requested_roles.name - team - team.name - uri x-ballerina-name: optFields responses: "200": description: Successfully retrieved the requested team's or workspace's project templates. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20027' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.projecttemplates.getProjectTemplates(team, workspace) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet projectTemplatesApiInstance = new Asana.ProjectTemplatesApi();\n\ let opts = { \n 'workspace': \"12345\", \n 'team': \"14916\", \n\ \ 'limit': 50, \n 'offset': \"eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9\"\ , \n 'opt_fields': \"color,description,html_description,name,offset,owner,path,public,requested_dates,requested_dates.description,requested_dates.name,requested_roles,requested_roles.name,team,team.name,uri\"\ \n};\nprojectTemplatesApiInstance.getProjectTemplates(opts).then((result)\ \ => {\n console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projecttemplates.getProjectTemplates({param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class project_templates_api_instance = asana.ProjectTemplatesApi(api_client) opts = { 'workspace': "12345", # str | The workspace to filter results on. 'team': "14916", # str | The team to filter projects on. 'limit': 50, # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': "color,description,html_description,name,offset,owner,path,public,requested_dates,requested_dates.description,requested_dates.name,requested_roles,requested_roles.name,team,team.name,uri", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get multiple project templates api_response = project_templates_api_instance.get_project_templates(opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling ProjectTemplatesApi->get_project_templates: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_templates.get_project_templates({'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- projecttemplates->getProjectTemplates(array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_templates.get_project_templates(param: "value", param: "value", options: {pretty: true}) /teams/{teamGid}/project_templates: get: tags: - Project templates summary: Get a team's project templates description: Returns the compact project template records for all project templates in the team. operationId: getProjectTemplatesForTeam parameters: - name: teamGid in: path description: Globally unique identifier for the team. required: true style: simple explode: false schema: type: string example: "159874" x-env-variable: team - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: limit in: query description: |- Results per page. The number of objects to return per page. The value must be between 1 and 100. required: false style: form explode: true schema: maximum: 100 minimum: 1 type: integer example: 50 - name: offset in: query description: |- Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' required: false style: form explode: true schema: type: string example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - color - description - html_description - name - offset - owner - path - public - requested_dates - requested_dates.description - requested_dates.name - requested_roles - requested_roles.name - team - team.name - uri example: - color - description - html_description - name - offset - owner - path - public - requested_dates - requested_dates.description - requested_dates.name - requested_roles - requested_roles.name - team - team.name - uri x-ballerina-name: optFields responses: "200": description: Successfully retrieved the requested team's project templates. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20027' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.projecttemplates.getProjectTemplatesForTeam(teamGid) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet projectTemplatesApiInstance = new Asana.ProjectTemplatesApi();\n\ let team_gid = \"159874\"; // String | Globally unique identifier for\ \ the team.\nlet opts = { \n 'limit': 50, \n 'offset': \"eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9\"\ , \n 'opt_fields': \"color,description,html_description,name,offset,owner,path,public,requested_dates,requested_dates.description,requested_dates.name,requested_roles,requested_roles.name,team,team.name,uri\"\ \n};\nprojectTemplatesApiInstance.getProjectTemplatesForTeam(team_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projecttemplates.getProjectTemplatesForTeam(teamGid, {param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class project_templates_api_instance = asana.ProjectTemplatesApi(api_client) team_gid = "159874" # str | Globally unique identifier for the team. opts = { 'limit': 50, # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'opt_fields': "color,description,html_description,name,offset,owner,path,public,requested_dates,requested_dates.description,requested_dates.name,requested_roles,requested_roles.name,team,team.name,uri", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get a team's project templates api_response = project_templates_api_instance.get_project_templates_for_team(team_gid, opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling ProjectTemplatesApi->get_project_templates_for_team: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_templates.get_project_templates_for_team(team_gid, {'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- projecttemplates->getProjectTemplatesForTeam($team_gid, array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_templates.get_project_templates_for_team(team_gid: 'team_gid', param: "value", param: "value", options: {pretty: true}) /project_templates/{projectTemplateGid}/instantiateProject: post: tags: - Project templates summary: Instantiate a project from a project template description: |- Creates and returns a job that will asynchronously handle the project instantiation. To form this request, it is recommended to first make a request to [get a project template](/reference/getprojecttemplate). Then, from the response, copy the `gid` from the object in the `requested_dates` array. This `gid` should be used in `requested_dates` to instantiate a project. _Note: The body of this request will differ if your workspace is an organization. To determine if your workspace is an organization, use the [is_organization](/reference/workspaces) parameter._ operationId: instantiateProject parameters: - name: projectTemplateGid in: path description: Globally unique identifier for the project template. required: true style: simple explode: false schema: type: string example: "1331" x-env-variable: project_template - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - new_project - new_project.name - new_project_template - new_project_template.name - new_task - new_task.created_by - new_task.name - new_task.resource_subtype - new_task_template - new_task_template.name - resource_subtype - status example: - new_project - new_project.name - new_project_template - new_project_template.name - new_task - new_task.created_by - new_task.name - new_task.resource_subtype - new_task_template - new_task_template.name - resource_subtype - status x-ballerina-name: optFields requestBody: description: "Describes the inputs used for instantiating a project, such\ \ as the resulting project's name, which team it should be created in, and\ \ values for date variables." content: application/json: schema: $ref: '#/components/schemas/ProjectTemplateGidInstantiateProjectBody' responses: "201": description: Successfully created the job to handle project instantiation. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20013' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Job result = client.projecttemplates.instantiateProject(projectTemplateGid) .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet projectTemplatesApiInstance = new Asana.ProjectTemplatesApi();\n\ let project_template_gid = \"1331\"; // String | Globally unique identifier\ \ for the project template.\nlet opts = { \n 'body': {\"data\": {\"\ \": \"\", \"\": \"\",}}, \n 'opt_fields':\ \ \"new_project,new_project.name,new_project_template,new_project_template.name,new_task,new_task.created_by,new_task.name,new_task.resource_subtype,resource_subtype,status\"\ \n};\nprojectTemplatesApiInstance.instantiateProject(project_template_gid,\ \ opts).then((result) => {\n console.log('API called successfully.\ \ Returned data: ' + JSON.stringify(result.data, null, 2));\n}, (error)\ \ => {\n console.error(error.response.body);\n});" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projecttemplates.instantiateProject(projectTemplateGid, {field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class project_templates_api_instance = asana.ProjectTemplatesApi(api_client) project_template_gid = "1331" # str | Globally unique identifier for the project template. opts = { 'body': {"data": {"": "", "": "",}}, # dict | Describes the inputs used for instantiating a project, such as the resulting project's name, which team it should be created in, and values for date variables. 'opt_fields': "new_project,new_project.name,new_project_template,new_project_template.name,new_task,new_task.created_by,new_task.name,new_task.resource_subtype,resource_subtype,status", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Instantiate a project from a project template api_response = project_templates_api_instance.instantiate_project(project_template_gid, opts) pprint(api_response) except ApiException as e: print("Exception when calling ProjectTemplatesApi->instantiate_project: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.project_templates.instantiate_project(project_template_gid, {'field': 'value', 'field': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- projecttemplates->instantiateProject($project_template_gid, array('field' => 'value', 'field' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.project_templates.instantiate_project(project_template_gid: 'project_template_gid', field: "value", field: "value", options: {pretty: true}) /projects: get: tags: - Projects summary: Get multiple projects description: |- Returns the compact project records for some filtered set of projects. Use one or more of the parameters provided to filter the projects returned. *Note: This endpoint may timeout for large domains. Try filtering by team!* operationId: getProjects parameters: - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: limit in: query description: |- Results per page. The number of objects to return per page. The value must be between 1 and 100. required: false style: form explode: true schema: maximum: 100 minimum: 1 type: integer example: 50 - name: offset in: query description: |- Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' required: false style: form explode: true schema: type: string example: eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9 - name: workspace in: query description: The workspace or organization to filter projects on. required: false style: form explode: true schema: type: string example: "1331" - name: team in: query description: The team to filter projects on. required: false style: form explode: true schema: type: string example: "14916" - name: archived in: query description: Only return projects whose `archived` field takes on the value of this parameter. required: false style: form explode: true schema: type: boolean example: false - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - archived - color - completed - completed_at - completed_by - completed_by.name - created_at - created_from_template - created_from_template.name - current_status - current_status.author - current_status.author.name - current_status.color - current_status.created_at - current_status.created_by - current_status.created_by.name - current_status.html_text - current_status.modified_at - current_status.text - current_status.title - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.id_prefix - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.representation_type - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.id_prefix - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.representation_type - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - default_access_level - default_view - due_date - due_on - followers - followers.name - html_notes - icon - members - members.name - minimum_access_level_for_customization - minimum_access_level_for_sharing - modified_at - name - notes - offset - owner - path - permalink_url - privacy_setting - project_brief - public - start_on - team - team.name - uri - workspace - workspace.name example: - archived - color - completed - completed_at - completed_by - completed_by.name - created_at - created_from_template - created_from_template.name - current_status - current_status.author - current_status.author.name - current_status.color - current_status.created_at - current_status.created_by - current_status.created_by.name - current_status.html_text - current_status.modified_at - current_status.text - current_status.title - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.id_prefix - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.representation_type - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.id_prefix - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.representation_type - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - default_access_level - default_view - due_date - due_on - followers - followers.name - html_notes - icon - members - members.name - minimum_access_level_for_customization - minimum_access_level_for_sharing - modified_at - name - notes - offset - owner - path - permalink_url - privacy_setting - project_brief - public - start_on - team - team.name - uri - workspace - workspace.name x-ballerina-name: optFields responses: "200": description: Successfully retrieved projects. content: application/json: schema: $ref: '#/components/schemas/InlineResponse20019' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); List result = client.projects.getProjects(archived, team, workspace) .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet projectsApiInstance = new Asana.ProjectsApi();\nlet opts = { \n\ \ 'limit': 50, \n 'offset': \"eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9\"\ , \n 'workspace': \"1331\", \n 'team': \"14916\", \n 'archived':\ \ false, \n 'opt_fields': \"archived,color,completed,completed_at,completed_by,completed_by.name,created_at,created_from_template,created_from_template.name,current_status,current_status.author,current_status.author.name,current_status.color,current_status.created_at,current_status.created_by,current_status.created_by.name,current_status.html_text,current_status.modified_at,current_status.text,current_status.title,current_status_update,current_status_update.resource_subtype,current_status_update.title,custom_field_settings,custom_field_settings.custom_field,custom_field_settings.custom_field.asana_created_field,custom_field_settings.custom_field.created_by,custom_field_settings.custom_field.created_by.name,custom_field_settings.custom_field.currency_code,custom_field_settings.custom_field.custom_label,custom_field_settings.custom_field.custom_label_position,custom_field_settings.custom_field.date_value,custom_field_settings.custom_field.date_value.date,custom_field_settings.custom_field.date_value.date_time,custom_field_settings.custom_field.description,custom_field_settings.custom_field.display_value,custom_field_settings.custom_field.enabled,custom_field_settings.custom_field.enum_options,custom_field_settings.custom_field.enum_options.color,custom_field_settings.custom_field.enum_options.enabled,custom_field_settings.custom_field.enum_options.name,custom_field_settings.custom_field.enum_value,custom_field_settings.custom_field.enum_value.color,custom_field_settings.custom_field.enum_value.enabled,custom_field_settings.custom_field.enum_value.name,custom_field_settings.custom_field.format,custom_field_settings.custom_field.has_notifications_enabled,custom_field_settings.custom_field.is_formula_field,custom_field_settings.custom_field.is_global_to_workspace,custom_field_settings.custom_field.is_value_read_only,custom_field_settings.custom_field.multi_enum_values,custom_field_settings.custom_field.multi_enum_values.color,custom_field_settings.custom_field.multi_enum_values.enabled,custom_field_settings.custom_field.multi_enum_values.name,custom_field_settings.custom_field.name,custom_field_settings.custom_field.number_value,custom_field_settings.custom_field.people_value,custom_field_settings.custom_field.people_value.name,custom_field_settings.custom_field.precision,custom_field_settings.custom_field.resource_subtype,custom_field_settings.custom_field.text_value,custom_field_settings.custom_field.type,custom_field_settings.is_important,custom_field_settings.parent,custom_field_settings.parent.name,custom_field_settings.project,custom_field_settings.project.name,custom_fields,custom_fields.date_value,custom_fields.date_value.date,custom_fields.date_value.date_time,custom_fields.display_value,custom_fields.enabled,custom_fields.enum_options,custom_fields.enum_options.color,custom_fields.enum_options.enabled,custom_fields.enum_options.name,custom_fields.enum_value,custom_fields.enum_value.color,custom_fields.enum_value.enabled,custom_fields.enum_value.name,custom_fields.is_formula_field,custom_fields.multi_enum_values,custom_fields.multi_enum_values.color,custom_fields.multi_enum_values.enabled,custom_fields.multi_enum_values.name,custom_fields.name,custom_fields.number_value,custom_fields.resource_subtype,custom_fields.text_value,custom_fields.type,default_access_level,default_view,due_date,due_on,followers,followers.name,html_notes,icon,members,members.name,minimum_access_level_for_customization,minimum_access_level_for_sharing,modified_at,name,notes,offset,owner,path,permalink_url,project_brief,public,start_on,team,team.name,uri,workspace,workspace.name\"\ \n};\nprojectsApiInstance.getProjects(opts).then((result) => {\n console.log('API\ \ called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projects.getProjects({param: "value", param: "value", opt_pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class projects_api_instance = asana.ProjectsApi(api_client) opts = { 'limit': 50, # int | Results per page. The number of objects to return per page. The value must be between 1 and 100. 'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", # str | Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' 'workspace': "1331", # str | The workspace or organization to filter projects on. 'team': "14916", # str | The team to filter projects on. 'archived': False, # bool | Only return projects whose `archived` field takes on the value of this parameter. 'opt_fields': "archived,color,completed,completed_at,completed_by,completed_by.name,created_at,created_from_template,created_from_template.name,current_status,current_status.author,current_status.author.name,current_status.color,current_status.created_at,current_status.created_by,current_status.created_by.name,current_status.html_text,current_status.modified_at,current_status.text,current_status.title,current_status_update,current_status_update.resource_subtype,current_status_update.title,custom_field_settings,custom_field_settings.custom_field,custom_field_settings.custom_field.asana_created_field,custom_field_settings.custom_field.created_by,custom_field_settings.custom_field.created_by.name,custom_field_settings.custom_field.currency_code,custom_field_settings.custom_field.custom_label,custom_field_settings.custom_field.custom_label_position,custom_field_settings.custom_field.date_value,custom_field_settings.custom_field.date_value.date,custom_field_settings.custom_field.date_value.date_time,custom_field_settings.custom_field.description,custom_field_settings.custom_field.display_value,custom_field_settings.custom_field.enabled,custom_field_settings.custom_field.enum_options,custom_field_settings.custom_field.enum_options.color,custom_field_settings.custom_field.enum_options.enabled,custom_field_settings.custom_field.enum_options.name,custom_field_settings.custom_field.enum_value,custom_field_settings.custom_field.enum_value.color,custom_field_settings.custom_field.enum_value.enabled,custom_field_settings.custom_field.enum_value.name,custom_field_settings.custom_field.format,custom_field_settings.custom_field.has_notifications_enabled,custom_field_settings.custom_field.id_prefix,custom_field_settings.custom_field.is_formula_field,custom_field_settings.custom_field.is_global_to_workspace,custom_field_settings.custom_field.is_value_read_only,custom_field_settings.custom_field.multi_enum_values,custom_field_settings.custom_field.multi_enum_values.color,custom_field_settings.custom_field.multi_enum_values.enabled,custom_field_settings.custom_field.multi_enum_values.name,custom_field_settings.custom_field.name,custom_field_settings.custom_field.number_value,custom_field_settings.custom_field.people_value,custom_field_settings.custom_field.people_value.name,custom_field_settings.custom_field.precision,custom_field_settings.custom_field.representation_type,custom_field_settings.custom_field.resource_subtype,custom_field_settings.custom_field.text_value,custom_field_settings.custom_field.type,custom_field_settings.is_important,custom_field_settings.parent,custom_field_settings.parent.name,custom_field_settings.project,custom_field_settings.project.name,custom_fields,custom_fields.date_value,custom_fields.date_value.date,custom_fields.date_value.date_time,custom_fields.display_value,custom_fields.enabled,custom_fields.enum_options,custom_fields.enum_options.color,custom_fields.enum_options.enabled,custom_fields.enum_options.name,custom_fields.enum_value,custom_fields.enum_value.color,custom_fields.enum_value.enabled,custom_fields.enum_value.name,custom_fields.id_prefix,custom_fields.is_formula_field,custom_fields.multi_enum_values,custom_fields.multi_enum_values.color,custom_fields.multi_enum_values.enabled,custom_fields.multi_enum_values.name,custom_fields.name,custom_fields.number_value,custom_fields.representation_type,custom_fields.resource_subtype,custom_fields.text_value,custom_fields.type,default_access_level,default_view,due_date,due_on,followers,followers.name,html_notes,icon,members,members.name,minimum_access_level_for_customization,minimum_access_level_for_sharing,modified_at,name,notes,offset,owner,path,permalink_url,project_brief,public,start_on,team,team.name,uri,workspace,workspace.name", # list[str] | This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. } try: # Get multiple projects api_response = projects_api_instance.get_projects(opts) for data in api_response: pprint(data) except ApiException as e: print("Exception when calling ProjectsApi->get_projects: %s\n" % e) name: python-sdk-v5 - language: python install: pip install asana==3.2.2 code: |- import asana client = asana.Client.access_token('PERSONAL_ACCESS_TOKEN') result = client.projects.get_projects({'param': 'value', 'param': 'value'}, opt_pretty=True) name: python-sdk-v3 - language: php install: composer require asana/asana code: |- projects->getProjects(array('param' => 'value', 'param' => 'value'), array('opt_pretty' => 'true')) - language: ruby install: gem install asana code: |- require 'asana' client = Asana::Client.new do |c| c.authentication :access_token, 'PERSONAL_ACCESS_TOKEN' end result = client.projects.get_projects(param: "value", param: "value", options: {pretty: true}) post: tags: - Projects summary: Create a project description: |- Create a new project in a workspace or team. Every project is required to be created in a specific workspace or organization, and this cannot be changed once set. Note that you can use the `workspace` parameter regardless of whether or not it is an organization. If the workspace for your project is an organization, you must also supply a `team` to share the project with. Returns the full record of the newly created project. operationId: createProject parameters: - name: opt_pretty in: query description: |- Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. required: false allowEmptyValue: true style: form explode: true schema: type: boolean example: true x-ballerina-name: optPretty - name: opt_fields in: query description: "This endpoint returns a compact resource, which excludes some\ \ properties by default. To include those optional properties, set this\ \ query parameter to a comma-separated list of the properties you wish to\ \ include." required: false style: form explode: false schema: type: array items: type: string enum: - archived - color - completed - completed_at - completed_by - completed_by.name - created_at - created_from_template - created_from_template.name - current_status - current_status.author - current_status.author.name - current_status.color - current_status.created_at - current_status.created_by - current_status.created_by.name - current_status.html_text - current_status.modified_at - current_status.text - current_status.title - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.id_prefix - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.representation_type - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.id_prefix - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.representation_type - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - default_access_level - default_view - due_date - due_on - followers - followers.name - html_notes - icon - members - members.name - minimum_access_level_for_customization - minimum_access_level_for_sharing - modified_at - name - notes - owner - permalink_url - privacy_setting - project_brief - public - start_on - team - team.name - workspace - workspace.name example: - archived - color - completed - completed_at - completed_by - completed_by.name - created_at - created_from_template - created_from_template.name - current_status - current_status.author - current_status.author.name - current_status.color - current_status.created_at - current_status.created_by - current_status.created_by.name - current_status.html_text - current_status.modified_at - current_status.text - current_status.title - current_status_update - current_status_update.resource_subtype - current_status_update.title - custom_field_settings - custom_field_settings.custom_field - custom_field_settings.custom_field.asana_created_field - custom_field_settings.custom_field.created_by - custom_field_settings.custom_field.created_by.name - custom_field_settings.custom_field.currency_code - custom_field_settings.custom_field.custom_label - custom_field_settings.custom_field.custom_label_position - custom_field_settings.custom_field.date_value - custom_field_settings.custom_field.date_value.date - custom_field_settings.custom_field.date_value.date_time - custom_field_settings.custom_field.description - custom_field_settings.custom_field.display_value - custom_field_settings.custom_field.enabled - custom_field_settings.custom_field.enum_options - custom_field_settings.custom_field.enum_options.color - custom_field_settings.custom_field.enum_options.enabled - custom_field_settings.custom_field.enum_options.name - custom_field_settings.custom_field.enum_value - custom_field_settings.custom_field.enum_value.color - custom_field_settings.custom_field.enum_value.enabled - custom_field_settings.custom_field.enum_value.name - custom_field_settings.custom_field.format - custom_field_settings.custom_field.has_notifications_enabled - custom_field_settings.custom_field.id_prefix - custom_field_settings.custom_field.is_formula_field - custom_field_settings.custom_field.is_global_to_workspace - custom_field_settings.custom_field.is_value_read_only - custom_field_settings.custom_field.multi_enum_values - custom_field_settings.custom_field.multi_enum_values.color - custom_field_settings.custom_field.multi_enum_values.enabled - custom_field_settings.custom_field.multi_enum_values.name - custom_field_settings.custom_field.name - custom_field_settings.custom_field.number_value - custom_field_settings.custom_field.people_value - custom_field_settings.custom_field.people_value.name - custom_field_settings.custom_field.precision - custom_field_settings.custom_field.representation_type - custom_field_settings.custom_field.resource_subtype - custom_field_settings.custom_field.text_value - custom_field_settings.custom_field.type - custom_field_settings.is_important - custom_field_settings.parent - custom_field_settings.parent.name - custom_field_settings.project - custom_field_settings.project.name - custom_fields - custom_fields.date_value - custom_fields.date_value.date - custom_fields.date_value.date_time - custom_fields.display_value - custom_fields.enabled - custom_fields.enum_options - custom_fields.enum_options.color - custom_fields.enum_options.enabled - custom_fields.enum_options.name - custom_fields.enum_value - custom_fields.enum_value.color - custom_fields.enum_value.enabled - custom_fields.enum_value.name - custom_fields.id_prefix - custom_fields.is_formula_field - custom_fields.multi_enum_values - custom_fields.multi_enum_values.color - custom_fields.multi_enum_values.enabled - custom_fields.multi_enum_values.name - custom_fields.name - custom_fields.number_value - custom_fields.representation_type - custom_fields.resource_subtype - custom_fields.text_value - custom_fields.type - default_access_level - default_view - due_date - due_on - followers - followers.name - html_notes - icon - members - members.name - minimum_access_level_for_customization - minimum_access_level_for_sharing - modified_at - name - notes - owner - permalink_url - privacy_setting - project_brief - public - start_on - team - team.name - workspace - workspace.name x-ballerina-name: optFields requestBody: description: The project to create. content: application/json: schema: $ref: '#/components/schemas/ProjectsBody' required: true responses: "201": description: Successfully retrieved projects. content: application/json: schema: $ref: '#/components/schemas/InlineResponse2015' "400": description: This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "401": description: "A valid authentication token was not provided with the request,\ \ so the API could not associate a user with the request." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "403": description: The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "404": description: "Either the request method and path supplied do not specify\ \ a known action in the API, or the object specified by the request does\ \ not exist." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' "500": description: "There was a problem on Asana’s end. In the event of a server\ \ error the response body should contain an error phrase. These phrases\ \ can be used by Asana support to quickly look up the incident that caused\ \ the server error. Some errors are due to server load, and will not supply\ \ an error phrase." content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' x-readme: code-samples: - language: java install: com.asanaasana1.0.0 code: |- import com.asana.Client; Client client = Client.accessToken("PERSONAL_ACCESS_TOKEN"); Project result = client.projects.createProject() .data("field", "value") .data("field", "value") .option("pretty", true) .execute(); - language: node install: npm install asana code: "const Asana = require('asana');\n\nlet client = Asana.ApiClient.instance;\n\ let token = client.authentications['token'];\ntoken.accessToken = '';\n\ \nlet projectsApiInstance = new Asana.ProjectsApi();\nlet body = {\"data\"\ : {\"\": \"\", \"\": \"\",}}; // Object\ \ | The project to create.\nlet opts = { \n 'opt_fields': \"archived,color,completed,completed_at,completed_by,completed_by.name,created_at,created_from_template,created_from_template.name,current_status,current_status.author,current_status.author.name,current_status.color,current_status.created_at,current_status.created_by,current_status.created_by.name,current_status.html_text,current_status.modified_at,current_status.text,current_status.title,current_status_update,current_status_update.resource_subtype,current_status_update.title,custom_field_settings,custom_field_settings.custom_field,custom_field_settings.custom_field.asana_created_field,custom_field_settings.custom_field.created_by,custom_field_settings.custom_field.created_by.name,custom_field_settings.custom_field.currency_code,custom_field_settings.custom_field.custom_label,custom_field_settings.custom_field.custom_label_position,custom_field_settings.custom_field.date_value,custom_field_settings.custom_field.date_value.date,custom_field_settings.custom_field.date_value.date_time,custom_field_settings.custom_field.description,custom_field_settings.custom_field.display_value,custom_field_settings.custom_field.enabled,custom_field_settings.custom_field.enum_options,custom_field_settings.custom_field.enum_options.color,custom_field_settings.custom_field.enum_options.enabled,custom_field_settings.custom_field.enum_options.name,custom_field_settings.custom_field.enum_value,custom_field_settings.custom_field.enum_value.color,custom_field_settings.custom_field.enum_value.enabled,custom_field_settings.custom_field.enum_value.name,custom_field_settings.custom_field.format,custom_field_settings.custom_field.has_notifications_enabled,custom_field_settings.custom_field.is_formula_field,custom_field_settings.custom_field.is_global_to_workspace,custom_field_settings.custom_field.is_value_read_only,custom_field_settings.custom_field.multi_enum_values,custom_field_settings.custom_field.multi_enum_values.color,custom_field_settings.custom_field.multi_enum_values.enabled,custom_field_settings.custom_field.multi_enum_values.name,custom_field_settings.custom_field.name,custom_field_settings.custom_field.number_value,custom_field_settings.custom_field.people_value,custom_field_settings.custom_field.people_value.name,custom_field_settings.custom_field.precision,custom_field_settings.custom_field.resource_subtype,custom_field_settings.custom_field.text_value,custom_field_settings.custom_field.type,custom_field_settings.is_important,custom_field_settings.parent,custom_field_settings.parent.name,custom_field_settings.project,custom_field_settings.project.name,custom_fields,custom_fields.date_value,custom_fields.date_value.date,custom_fields.date_value.date_time,custom_fields.display_value,custom_fields.enabled,custom_fields.enum_options,custom_fields.enum_options.color,custom_fields.enum_options.enabled,custom_fields.enum_options.name,custom_fields.enum_value,custom_fields.enum_value.color,custom_fields.enum_value.enabled,custom_fields.enum_value.name,custom_fields.is_formula_field,custom_fields.multi_enum_values,custom_fields.multi_enum_values.color,custom_fields.multi_enum_values.enabled,custom_fields.multi_enum_values.name,custom_fields.name,custom_fields.number_value,custom_fields.resource_subtype,custom_fields.text_value,custom_fields.type,default_access_level,default_view,due_date,due_on,followers,followers.name,html_notes,icon,members,members.name,minimum_access_level_for_customization,minimum_access_level_for_sharing,modified_at,name,notes,owner,permalink_url,project_brief,public,start_on,team,team.name,workspace,workspace.name\"\ \n};\nprojectsApiInstance.createProject(body, opts).then((result) => {\n\ \ console.log('API called successfully. Returned data: ' + JSON.stringify(result.data,\ \ null, 2));\n}, (error) => {\n console.error(error.response.body);\n\ });" name: node-sdk-v3 - language: node install: npm install asana@1.0.2 code: |- const asana = require('asana'); const client = asana.Client.create().useAccessToken('PERSONAL_ACCESS_TOKEN'); client.projects.createProject({field: "value", field: "value", pretty: true}) .then((result) => { console.log(result); }); name: node-sdk-v1 - language: python install: pip install asana code: |- import asana from asana.rest import ApiException from pprint import pprint configuration = asana.Configuration() configuration.access_token = '' api_client = asana.ApiClient(configuration) # create an instance of the API class projects_api_instance = asana.ProjectsApi(api_client) body = {"data": {"": "", "": "